Skip to content

Commit

Permalink
contributing: move dev guide from readme
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 a5558f3 commit fca151a
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 77 deletions.
76 changes: 76 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
## Contributing

### Getting started

1. [Install Nix](https://zero-to-nix.com/concepts/nix-installer)
2. Enter the development environment with

```sh
nix develop .#
```

Or activate [direnv](https://direnv.net/) to automatically enter the nix shell.
It is recommended to use [nix-direnv](https://github.com/nix-community/nix-direnv).
If your system ships outdated bash, [install direnv](https://direnv.net/docs/installation.html) via package manager.
Additionally, you may want to add the [vscode extension](https://github.com/direnv/direnv-vscode).

```sh
direnv allow
```

3. Execute and follow instructions of

```sh
just onboard
```

4. Provision a CoCo enabled AKS cluster with

```sh
just create
```

The kubeconfig of the cluster will be automatically downloaded and merged with your default config.
You can get the kubeconfig of the running cluster at a later time with

```sh
just get-credentials
```

### Deploy

5. To build, containerize, push and deploy, run

```sh
just
```

Ensure the pushed container images are accessible to your cluster.

6. Set the manifest after the Coordinator has started with

```sh
just set
```

### Cleanup

7. Destroy the cluster with

```sh
just destroy
```

### Maintenance tasks

- Run code generation

```sh
just codegen
```

- Format all code

```sh
nix fmt
```
77 changes: 0 additions & 77 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,80 +26,3 @@ app, making it easier to assure stakeholders of your app's security.

Nunki provides an Initializer that handles the remote attestation on the workload side transparently and
fetches the workload certificate. The Initializer runs as init container before your workload is started.

## Contributing

### Getting started

1. [Install Nix](https://zero-to-nix.com/concepts/nix-installer)
2. Enter the development environment with

```sh
nix develop .#
```

Or activate [direnv](https://direnv.net/) to automatically enter the nix shell.
It is recommended to use [nix-direnv](https://github.com/nix-community/nix-direnv).
If your system ships outdated bash, [install direnv](https://direnv.net/docs/installation.html) via package manager.
Additionally, you may want to add the [vscode extension](https://github.com/direnv/direnv-vscode).

```sh
direnv allow
```

3. Execute and follow instructions of

```sh
just onboard
```

4. Provision a CoCo enabled AKS cluster with

```sh
just create
```

The kubeconfig of the cluster will be automatically downloaded and merged with your default config.
You can get the kubeconfig of the running cluster at a later time with

```sh
just get-credentials
```

### Deploy

5. To build, containerize, push and deploy, run

```sh
just
```

Ensure the pushed container images are accessible to your cluster.

6. Set the manifest after the Coordinator has started with

```sh
just set
```

### Cleanup

7. Destroy the cluster with

```sh
just destroy
```

### Maintenance tasks

- Run code generation

```sh
just codegen
```

- Format all code

```sh
nix fmt
```

0 comments on commit fca151a

Please sign in to comment.