From a7362b60e73a9ac6521124cefb58efae0bad511d Mon Sep 17 00:00:00 2001 From: Philip Laine Date: Thu, 17 Dec 2020 14:42:41 +0100 Subject: [PATCH 1/2] Add note about deploy key linked to pat Signed-off-by: Philip Laine --- docs/get-started/index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/get-started/index.md b/docs/get-started/index.md index ef3c1a58..228780e3 100644 --- a/docs/get-started/index.md +++ b/docs/get-started/index.md @@ -102,6 +102,12 @@ The bootstrap command creates a repository if one doesn't exist, and commits the manifests for the Flux components to the default branch at the specified path. Then it configures the target cluster to synchronize with the specified path inside the repository. +!!! hint "Deploy Key" + The bootstrap command creates a ssh key which it stores as a secret in the + Kubernetes cluster. The key is also used to create a deploy key in the GitHub + repository. The new deploy key will be linked to the personal access token used + to authenticate. Removing the personal access token will remove the deploy key. + If you wish to create the repository under a GitHub organization: ```sh From 3de81827eb8473b4640413f370f4a6836096d582 Mon Sep 17 00:00:00 2001 From: Philip Laine Date: Thu, 17 Dec 2020 14:53:05 +0100 Subject: [PATCH 2/2] Move hint to github guide Signed-off-by: Philip Laine --- docs/get-started/index.md | 6 ------ docs/guides/installation.md | 6 ++++++ 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/get-started/index.md b/docs/get-started/index.md index 228780e3..ef3c1a58 100644 --- a/docs/get-started/index.md +++ b/docs/get-started/index.md @@ -102,12 +102,6 @@ The bootstrap command creates a repository if one doesn't exist, and commits the manifests for the Flux components to the default branch at the specified path. Then it configures the target cluster to synchronize with the specified path inside the repository. -!!! hint "Deploy Key" - The bootstrap command creates a ssh key which it stores as a secret in the - Kubernetes cluster. The key is also used to create a deploy key in the GitHub - repository. The new deploy key will be linked to the personal access token used - to authenticate. Removing the personal access token will remove the deploy key. - If you wish to create the repository under a GitHub organization: ```sh diff --git a/docs/guides/installation.md b/docs/guides/installation.md index 79a26ecd..cc057257 100644 --- a/docs/guides/installation.md +++ b/docs/guides/installation.md @@ -118,6 +118,12 @@ flux bootstrap github \ --personal ``` +!!! hint "Deploy Key" + The bootstrap command creates a ssh key which it stores as a secret in the + Kubernetes cluster. The key is also used to create a deploy key in the GitHub + repository. The new deploy key will be linked to the personal access token used + to authenticate. Removing the personal access token will remove the deploy key. + Run the bootstrap for a repository owned by a GitHub organization: ```sh