Skip to content
This repository has been archived by the owner on Oct 10, 2023. It is now read-only.

Commit

Permalink
Adding documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Sathyanarayanan Saravanamuthu committed Jun 22, 2023
1 parent 9f32f12 commit 47a2d3d
Showing 1 changed file with 9 additions and 37 deletions.
46 changes: 9 additions & 37 deletions docs/runtime-core/readiness-framework/deploy-local-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,50 +7,22 @@
3. ytt
4. Kubectl

## Step 1 - Create a Kind cluster
## Environment varialbes

A simple Kind cluster can be created for testing using the following command.
Please set the environment variable `KINDCLUSTER` to override the Kind cluster name that will be created. This environment variables applies for all the commands described below. If unset, Kind cluster with name `kind` gets created.

```bash
kind create cluster
```

## Step 2 - Generate manifests

This step is required only if there is a change in the readiness APIs. Run the following commands to generage the CRD manifests for the updated APIs.

```bash
make manifests
```

## Step 3 - Sync the generated manifests
## Deploy local changes to a kind cluster

This step is required only if there is a change in the readiness APIs. Run the following commands to sync the newly generated CRDs to the packages directory.
Run the following command to install the readiness framework in a Kind cluster.

```bash
make package-vendir-sync
make deploy-local-readiness
```

## Step 4 - Build docker image
## Run end-to-end tests

Run the following command from the `tanzu-framework` directory.
The end-to-end tests can be triggered on the local Kind cluster by running the following command.

```bash
COMPONENTS=readiness/controller.readiness-controller-manager.readiness make docker-build-all
```

## Step 5 - Load readiness controller image

Load the readiness controller image into the kind nodes by running the following command.

```bash
kind load docker-image readiness-controller-manager:latest
```

## Step 6 - Deploy the manifests

Run the following command to deploy CRDs and bring up the readiness controller.

```bash
ytt -f packages/readiness/bundle/config | kubectl apply -f-
```
make e2e-readiness
```

0 comments on commit 47a2d3d

Please sign in to comment.