From 92922f49e8e38c08095b97b48f8e52fa1b97bba8 Mon Sep 17 00:00:00 2001 From: Omer Levi Hevroni Date: Thu, 18 Apr 2019 13:15:51 +0300 Subject: [PATCH] document aws role usage (#160) --- README.md | 4 ++-- site/content/docs/user/install.md | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 25122df34..e017c4639 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ The simple way to run Kamus is by using the Helm chart: helm repo add soluto https://charts.soluto.io helm upgrade --install kamus soluto/kamus ``` -Refer to the [installation guide](./docs/install.md) for more details. +Refer to the [installation guide](https://kamus.soluto.io/docs/user/install/) for more details. After installing Kamus, you can start using it to encrypt secrets. Kamus encrypt secrets for a specific application, represent by a [Kubernetes Service Account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account). Create a service account for your application, and mount it on the pods running your application. @@ -58,7 +58,7 @@ Consult the [installation guide](docs/install.md) for more details on how to dep Kamus is shipped with 2 utilities that make it easier to use: * Kamus CLI - a small CLI that eases the interaction with the Encrypt API. Refer to the [docs](/~https://github.com/Soluto/kamus/blob/master/cli/README.md) for more details. * Kamus init container - a init container that interacts with the Decrypt API. Refer to the [docs](/~https://github.com/Soluto/kamus/blob/master/init-container/README.md) for more details. -* CRD Controller - allowing to create native Kubernetes secrets using Kamus. Refer to the [docs](/~https://github.com/Soluto/kamus/blob/master/docs/crd.md) for more details. +* CRD Controller - allowing to create native Kubernetes secrets using Kamus. Refer to the [docs](https://kamus.soluto.io/docs/user/crd/) for more details. ## Security We take security seriously at Soluto. diff --git a/site/content/docs/user/install.md b/site/content/docs/user/install.md index 5d9db1e40..e452a883e 100644 --- a/site/content/docs/user/install.md +++ b/site/content/docs/user/install.md @@ -128,6 +128,7 @@ Typical values.yaml for AWS : ```yaml keyManagement: provider: AwsKms + region: ``` If you want to pass user access key and secret to Kamus deploy use the following values.yaml command: ```yaml @@ -138,7 +139,7 @@ keyManagement: key: <> secret: <> ``` -You can also provide `cmkPrefix` values to give the custerom master keys that Kamus creates better visibility, if not specific the keys alias will be called `kamus-`. +You can also provide `cmkPrefix` values to give the custerom master keys that Kamus creates better visibility, if not specific the keys alias will be called `kamus-`. And now deploy Kamus using the following helm command: ``` helm upgrade --install kamus soluto/kamus -f