Skip to content

Commit 69c6c21

Browse files
authored
Clarify KIND info (#273)
Signed-off-by: Dean Roehrich <dean.roehrich@hpe.com>
1 parent bb16d87 commit 69c6c21

1 file changed

Lines changed: 16 additions & 8 deletions

File tree

Readme.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
****# NNF Deployment
1+
# NNF Deployment
22

33
To clone this project, use the additional --recurse-submodules option to retrieve its submodules:
44

@@ -106,7 +106,8 @@ Deploy all the submodules using the `deploy` command
106106
./nnf-deploy deploy
107107
```
108108

109-
To deploy only specific repositories, include the desired modules after `deploy` command. For example, to deploy only `dws` and `nnf-sos` repositories, use
109+
To deploy only specific repositories, include the desired modules after `deploy` command. For example, to deploy only `dws` and `nnf-sos` repositories:
110+
110111
```bash
111112
./nnf-deploy deploy dws nnf-sos
112113
```
@@ -140,22 +141,30 @@ The `make` subcommand provides direct access to makefile targets within each sub
140141
./nnf-deploy make docker-build
141142
```
142143

143-
### Kind cluster
144+
## KIND cluster
144145

145-
Kind clusters are built and deployed using locally compiled images. The following commands:
146+
[Kubernetes-in-Docker](https://kind.sigs.k8s.io) (KIND) clusters are built and deployed using locally compiled images.
146147

147148
- Create a kind cluster
149+
- Attach ArgoCD to your gitops repo, which you created from the [argocd-boilerplate](https://github.com/NearNodeFlash/argocd-boilerplate). Otherwise, see the "overlay legacy" step in "Init" above, to run the cluster without ArgoCD.
148150
- Build all docker images for Rabbit modules
149151
- Push those images into the Kind cluster
152+
- Make a manifest for these images. Run `make manifests` and use the `./tools/unpack-manifest.py` tool in your gitops repo to unpack the `manifests-kind.tar` file.
150153
- Deploy those images onto the Kind cluster nodes
151154

152-
```bash
153-
./tools/kind.sh reset
155+
```console
156+
./tools/kind.sh create
157+
./tools/kind.sh argocd_attach $ARGOCD_PASSWORD
154158
./nnf-deploy make docker-build
155159
./nnf-deploy make kind-push
156-
./nnf-deploy deploy
157160
```
158161

162+
Next, use the `./tools/deploy-env.sh` tool in your gitops repo to deploy the bootstrap resources to ArgoCD in your cluster.
163+
164+
### KIND with existing NNF releases
165+
166+
A KIND cluster may be used to test existing releases. Use the same steps described above, skipping the `nnf-deploy make ...` commands because existing releases will pull their images from the upstream registry. Download the `manifests-kind.tar` file from the desired NNF release at [nnf-deploy releases](https://github.com/NearNodeFlash/nnf-deploy/releases) and use the `./tools/unpack-manifests.py` tool in your gitops repo to unpack the manifest.
167+
159168
## Install
160169

161170
The `install` subcommand will compile and install the daemons on the compute nodes, along with the
@@ -164,4 +173,3 @@ proper certs and tokens. Systemd files are used to manage and start the daemons.
164173
```bash
165174
./nnf-deploy install
166175
```
167-

0 commit comments

Comments
 (0)