Skip to content

Commit

Permalink
Merge pull request #49 from pachyderm/readme-fix
Browse files Browse the repository at this point in the history
Fix small issues with README
  • Loading branch information
robert-uhl authored Mar 29, 2021
2 parents be1a597 + bbadc53 commit 1f947fb
Showing 1 changed file with 24 additions and 23 deletions.
47 changes: 24 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,51 +2,52 @@

The repo contains the pachyderm helm chart.

Status: **Experimental**

## Folder Structure

```
pachyderm - the helm chart itself
test - Go based tests for the helm chart
```

## Developer Guide
To run the tests for the helm chart, run the following:

```
make test
```shell
$ make test
```

# Diff against `pachctl`

To see how this Helm chart and `pachctl deploy` differ, one can do
something similar to the following:

1. Generate a `pachctl` manifest with `pachctl deploy google
BUCKET-NAME 10 --dynamic-etcd-nodes 1 -o yaml --dry-run >
pachmanifest.yaml`
2. Generate a Helm manifest with `helm template -f
examples/gcp-values.yaml ./pachyderm > helmmanifest.yaml`
3. Visually diff the two.
1. Generate a `pachctl` manifest with

```shell
$ pachctl deploy googleBUCKET-NAME 10 --dynamic-etcd-nodes 1 -o yaml --dry-run > pachmanifest.yaml
```

1. Generate a Helm manifest with

```shell
$ helm template -f examples/gcp-values.yaml ./pachyderm > helmmanifest.yaml
```

1. Visually diff the two.

# JSON Schema

We use [helm-schema-gen](https://github.com/karuppiah7890/helm-schema-gen)
to manage the JSON schema. It can be installed with:

```sh
```shell
$ helm plugin install https://github.com/karuppiah7890/helm-schema-gen.git
```

When updating `values.yaml` please run the following to update the
json schema file.

```sh
cd pachyderm
helm schema-gen values.yaml > values.schema.json
```shell
$ cd pachyderm
$ helm schema-gen values.yaml > values.schema.json
```

# Validate Helm manifest
1. `go install github.com/instrumenta/kubeval`
2. `kubeval helmmanifest.yaml`

```shell
go install github.com/instrumenta/kubeval
kubeval helmmanifest.yaml
```

0 comments on commit 1f947fb

Please sign in to comment.