Skip to content

Commit

Permalink
contributing: update
Browse files Browse the repository at this point in the history
Signed-off-by: Paul Meyer <[email protected]>
  • Loading branch information
katexochen committed Jan 22, 2024
1 parent fca151a commit eb56def
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,31 @@

### Deploy

5. To build, containerize, push and deploy, run
The ususally dev flow is available as a single target to execute:

```sh
just
```
```sh
just [default <deployment-name>]
```

Ensure the pushed container images are accessible to your cluster.
This will build, containerize and push all relevant components.
Ensure the pushed container images are accessible to your cluster.
The manifest will the be generated (`nunki generate`).

6. Set the manifest after the Coordinator has started with
Further the flow will deploy the selected deployment and wait for components to come up.
The manifest will automatically be set (`nunki set`) and the Coordinator will will be verified
(`nunki verify`). The flow will also wait for the workload to get ready.

```sh
just set
```
This target is idempotent and will delete an existing deployment before re-deploying.

All steps can be executed as separate targets. To list all available targets and their description, run

```sh
just --list
```

### Cleanup

7. Destroy the cluster with
- Destroy the cluster with

```sh
just destroy
Expand Down

0 comments on commit eb56def

Please sign in to comment.