|
1 | | -# DDN Helm Charts |
2 | | - |
3 | | -This repository contains Helm charts to help with the deployment of DDN on Kubernetes. This project is currently in active development. |
4 | | - |
5 | | -## Get Started |
6 | | - |
7 | | -See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation. |
8 | | - |
9 | | -### Repository |
10 | | - |
11 | | -The Charts are available in a Helm Chart Repository. [Helm](https://helm.sh) must be installed to use these charts. |
12 | | -Please refer to the [official documentation](https://helm.sh/docs/intro/install/) to get started. |
13 | | - |
14 | | -```bash |
15 | | -helm repo add hasura-ddn https://hasura.github.io/ddn-helm-charts/ |
16 | | -helm repo update |
17 | | -``` |
18 | | - |
19 | | -You can then see the charts by running: |
20 | | - |
21 | | -```bash |
22 | | -helm search repo hasura-ddn |
23 | | -``` |
24 | | - |
25 | | -> You can change the repo name `hasura-ddn` to another one if getting conflicts. |
26 | | -
|
27 | | -For more information, have a look at the [Using Helm](https://helm.sh/docs/intro/using_helm/#helm-repo-working-with-repositories) documentation. |
28 | | - |
29 | | -### Using git for metadata files |
30 | | -To enable git-sync to read engine and connector config files from a git repository, follow the below steps, |
31 | | - |
32 | | -Create a SSH key and grant it *read* access to the repository. It can also be a deploy key, see [set up deploy keys] https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys#set-up-deploy-keys |
33 | | - |
34 | | -Create a known hosts file, to add GitHub’s SSH host key to your known_hosts file to prevent SSH from asking for confirmation during the connection: |
35 | | -```bash |
36 | | -ssh-keyscan github.com >> ~/.ssh/known_hosts |
37 | | -``` |
38 | | - |
39 | | -Create a kubernetes secret using the below command, |
40 | | - |
41 | | -```bash |
42 | | -kubectl create secret generic git-creds \ |
43 | | - --from-file=ssh=~/.ssh/id_rsa \ |
44 | | - --from-file=known_hosts=~/.ssh/known_hosts |
45 | | -``` |
46 | | - |
47 | | -## Contributing |
48 | | - |
49 | | -Check out our [contributing guide](./CONTRIBUTING.md) for more details. |
50 | | - |
51 | | -## License |
52 | | - |
| 1 | +# DDN Helm Charts |
| 2 | + |
| 3 | +This repository contains Helm charts to help with the deployment of DDN on Kubernetes. This project is currently in active development. |
| 4 | + |
| 5 | +## Get Started |
| 6 | + |
| 7 | +See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation. |
| 8 | + |
| 9 | +### Repository |
| 10 | + |
| 11 | +The Charts are available in a Helm Chart Repository. [Helm](https://helm.sh) must be installed to use these charts. |
| 12 | +Please refer to the [official documentation](https://helm.sh/docs/intro/install/) to get started. |
| 13 | + |
| 14 | +```bash |
| 15 | +helm repo add hasura-ddn https://hasura.github.io/ddn-helm-charts/ |
| 16 | +helm repo update |
| 17 | +``` |
| 18 | + |
| 19 | +You can then see the charts by running: |
| 20 | + |
| 21 | +```bash |
| 22 | +helm search repo hasura-ddn |
| 23 | +``` |
| 24 | + |
| 25 | +> You can change the repo name `hasura-ddn` to another one if getting conflicts. |
| 26 | +
|
| 27 | +For more information, have a look at the [Using Helm](https://helm.sh/docs/intro/using_helm/#helm-repo-working-with-repositories) documentation. |
| 28 | + |
| 29 | +### Using git for metadata files |
| 30 | +To enable git-sync to read engine or connector config files from a git repository, follow the below steps. |
| 31 | + |
| 32 | +1. Create a Git repository. Depending on your use case, you can create it as `public` or `private` repo |
| 33 | + |
| 34 | +2. If you create it as a `public` repository and you want to use an `https` based checkout, you have completed your base setup. In other cases, proceed to the next step. |
| 35 | + |
| 36 | +3. Create a SSH key and grant it *read* access to the repository. It can also be a deploy key (See [set up deploy keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys#set-up-deploy-keys)) |
| 37 | + |
| 38 | +4. Create a known hosts file, to add GitHub’s SSH host key to your known_hosts file to prevent SSH from asking for confirmation during the connection: |
| 39 | + |
| 40 | +```bash |
| 41 | +ssh-keyscan github.com >> ~/.ssh/known_hosts |
| 42 | +``` |
| 43 | + |
| 44 | +5. Create a kubernetes secret using the below command |
| 45 | + |
| 46 | +```bash |
| 47 | +kubectl create secret generic git-creds \ |
| 48 | + --from-file=ssh=~/.ssh/id_rsa \ |
| 49 | + --from-file=known_hosts=~/.ssh/known_hosts |
| 50 | +``` |
| 51 | + |
| 52 | +## Contributing |
| 53 | + |
| 54 | +Check out our [contributing guide](./CONTRIBUTING.md) for more details. |
| 55 | + |
| 56 | +## License |
| 57 | + |
53 | 58 | Resources in this repository are released under the [Apache 2.0 license](./LICENSE). |
0 commit comments