Merge pull request #2395 from fluxcd/docs-1.14.1

Set fluxctl namespace in docs
fluxcd · Aug 22, 2019 · fabc238 · fabc238
2 parents bc1c8e8 + 973a179
commit fabc238
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 10 deletions.
diff --git a/chart/flux/README.md b/chart/flux/README.md
@@ -158,7 +158,7 @@ Find the SSH public key by installing [fluxctl](https://docs.fluxcd.io/en/latest
 running:
 
 ```sh
-fluxctl identity
+fluxctl identity --k8s-fwd-ns flux
 ```
 
 In order to sync your cluster state with GitHub you need to copy the

diff --git a/docs/tutorials/driving-flux.md b/docs/tutorials/driving-flux.md
@@ -13,10 +13,16 @@ deployment](https://github.com/fluxcd/flux-get-started) and click on the
 
 First, please [install `fluxctl`](../references/fluxctl.md).
 
-Then, run
+Then, run (replace `YOURUSER` with your GitHub username):
 
 ```sh
-fluxctl install --git-url=git@github.com/<your-user>/flux-get-started --git-email=someone@domain.com | kubectl apply -f -
+export GHUSER="YOURUSER"
+fluxctl install \
+--git-user=${GHUSER} \
+--git-email=${GHUSER}@users.noreply.github.com \
+--git-url=git@github.com:${GHUSER}/flux-get-started \
+--git-paths=namespaces,workloads \
+--namespace=flux | kubectl apply -f -
 ```
 
 ### Alternative: Using Helm for the setup
@@ -89,6 +95,12 @@ interact with the deployments. (It enables you to drive all of Flux, so have a l
 at the resulting annotation changes and make the changes in Git. This is
 GitOps after all. :-)
 
+Tell fluxctl in which namespace is Flux installed
+
+```sh
+export FLUX_FORWARD_NAMESPACE=flux
+```
+
 To enable Flux to sync your config, you need to add the deployment key
 to your fork.
 
@@ -115,7 +127,7 @@ images are available and what needs doing. To find out which workloads are
 managed by Flux, run
 
 ```sh
-fluxctl list-workloads -a
+fluxctl list-workloads -a 
 ```
 
 Notice that `podinfo` is on `v1.3.2` and in state `automated`.

diff --git a/docs/tutorials/get-started-kustomize.md b/docs/tutorials/get-started-kustomize.md
@@ -109,7 +109,7 @@ the SSH public key by installing [fluxctl](../references/fluxctl.md) and
 running:
 
 ```sh
-fluxctl identity
+fluxctl identity --k8s-fwd-ns flux
 ```
 
 In order to sync your cluster state with git you need to copy the
@@ -136,7 +136,7 @@ By default, Flux git pull frequency is set to 5 minutes.
 You can tell Flux to sync the changes immediately with:
 
 ```sh
-fluxctl sync
+fluxctl sync --k8s-fwd-ns flux
 ```
 
 ## Confirm the change landed

diff --git a/docs/tutorials/get-started.md b/docs/tutorials/get-started.md
@@ -65,7 +65,7 @@ the SSH public key by installing [`fluxctl`](../references/fluxctl.md) and
 running:
 
 ```sh
-fluxctl identity
+fluxctl identity --k8s-fwd-ns flux
 ```
 
 In order to sync your cluster state with git you need to copy the
@@ -91,8 +91,7 @@ paste the key there.)
 ## Committing a small change
 
 In this example we are using a simple example of a webservice and
-change its configuration to use a different message. The easiest
-way is to edit your fork of `flux-get-started` and change the `PODINFO_UI_COLOR` env var to `blue`.
+change its configuration to use a different message.
 
 Replace `YOURUSER` in
 `https://github.com/YOURUSER/flux-get-started/blob/master/workloads/podinfo-dep.yaml`
@@ -103,7 +102,7 @@ By default, Flux git pull frequency is set to 5 minutes.
 You can tell Flux to sync the changes immediately with:
 
 ```sh
-fluxctl sync
+fluxctl sync --k8s-fwd-ns flux
 ```
 
 ## Confirm the change landed