Update docs for release 0.13.0

weaveworks · Dec 21, 2022 · 075a2d5 · 075a2d5
1 parent b31086e
commit 075a2d5
Show file tree

Hide file tree

Showing 146 changed files with 12,565 additions and 35 deletions.
diff --git a/website/docs/installation/weave-gitops.mdx b/website/docs/installation/weave-gitops.mdx
@@ -103,7 +103,7 @@ import TabItem from "@theme/TabItem";
 <TabItem value="curl" label="curl">
 
 ```bash
-curl --silent --location "https://github.com/weaveworks/weave-gitops/releases/download/v0.12.0/gitops-$(uname)-$(uname -m).tar.gz" | tar xz -C /tmp
+curl --silent --location "https://github.com/weaveworks/weave-gitops/releases/download/v0.13.0/gitops-$(uname)-$(uname -m).tar.gz" | tar xz -C /tmp
 sudo mv /tmp/gitops /usr/local/bin
 gitops version
 ```

diff --git a/website/docs/references/cli-reference/gitops.md b/website/docs/references/cli-reference/gitops.md
@@ -28,7 +28,7 @@ Command line utility for managing Kubernetes applications via GitOps.
   -h, --help                                       help for gitops
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```
@@ -44,4 +44,4 @@ Command line utility for managing Kubernetes applications via GitOps.
 * [gitops set](gitops_set.md)	 - Sets one or many Weave GitOps CLI configs or resources
 * [gitops version](gitops_version.md)	 - Display gitops version
 
-###### Auto generated by spf13/cobra on 8-Dec-2022
+###### Auto generated by spf13/cobra on 21-Dec-2022
diff --git a/website/docs/references/cli-reference/gitops_beta.md b/website/docs/references/cli-reference/gitops_beta.md
@@ -14,7 +14,7 @@ This component contains unstable or still-in-development functionality
   -e, --endpoint WEAVE_GITOPS_ENTERPRISE_API_URL   The Weave GitOps Enterprise HTTP API endpoint can be set with WEAVE_GITOPS_ENTERPRISE_API_URL environment variable
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```
@@ -24,4 +24,4 @@ This component contains unstable or still-in-development functionality
 * [gitops](gitops.md)	 - Weave GitOps
 * [gitops beta run](gitops_beta_run.md)	 - Set up an interactive sync between your cluster and your local file system
 
-###### Auto generated by spf13/cobra on 8-Dec-2022
+###### Auto generated by spf13/cobra on 21-Dec-2022
diff --git a/website/docs/references/cli-reference/gitops_beta_run.md b/website/docs/references/cli-reference/gitops_beta_run.md
@@ -53,7 +53,7 @@ gitops beta run ./chart/podinfo --timeout 3m --port-forward namespace=flux-syste
       --no-session                         Disable session management. If not specified, the session will be enabled by default.
       --port-forward string                Forward the port from a cluster's resource to your local machine i.e. 'port=8080:8080,resource=svc/app'.
       --root-dir string                    Specify the root directory to watch for changes. If not specified, the root of Git repository will be used.
-      --session-name string                Specify the name of the session. If not specified, the name of the current branch and the last commit id will be used. (default "run-main-9229d8f5-dirty")
+      --session-name string                Specify the name of the session. If not specified, the name of the current branch and the last commit id will be used. (default "run-main-b31086e4-dirty")
       --session-namespace string           Specify the namespace of the session. (default "default")
       --skip-dashboard-install             Skip installation of the Dashboard. This also disables the prompt asking whether the Dashboard should be installed.
       --skip-resource-cleanup              Skip resource cleanup. If not specified, the GitOps Run resources will be deleted by default.
@@ -66,7 +66,7 @@ gitops beta run ./chart/podinfo --timeout 3m --port-forward namespace=flux-syste
   -e, --endpoint WEAVE_GITOPS_ENTERPRISE_API_URL   The Weave GitOps Enterprise HTTP API endpoint can be set with WEAVE_GITOPS_ENTERPRISE_API_URL environment variable
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```

diff --git a/website/docs/references/cli-reference/gitops_check.md b/website/docs/references/cli-reference/gitops_check.md
@@ -27,7 +27,7 @@ gitops check
   -e, --endpoint WEAVE_GITOPS_ENTERPRISE_API_URL   The Weave GitOps Enterprise HTTP API endpoint can be set with WEAVE_GITOPS_ENTERPRISE_API_URL environment variable
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```
@@ -36,4 +36,4 @@ gitops check
 
 * [gitops](gitops.md)	 - Weave GitOps
 
-###### Auto generated by spf13/cobra on 8-Dec-2022
+###### Auto generated by spf13/cobra on 21-Dec-2022
diff --git a/website/docs/references/cli-reference/gitops_completion.md b/website/docs/references/cli-reference/gitops_completion.md
@@ -20,7 +20,7 @@ See each sub-command's help for details on how to use the generated script.
   -e, --endpoint WEAVE_GITOPS_ENTERPRISE_API_URL   The Weave GitOps Enterprise HTTP API endpoint can be set with WEAVE_GITOPS_ENTERPRISE_API_URL environment variable
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```
@@ -33,4 +33,4 @@ See each sub-command's help for details on how to use the generated script.
 * [gitops completion powershell](gitops_completion_powershell.md)	 - Generate the autocompletion script for powershell
 * [gitops completion zsh](gitops_completion_zsh.md)	 - Generate the autocompletion script for zsh
 
-###### Auto generated by spf13/cobra on 8-Dec-2022
+###### Auto generated by spf13/cobra on 21-Dec-2022
diff --git a/website/docs/references/cli-reference/gitops_completion_bash.md b/website/docs/references/cli-reference/gitops_completion_bash.md
@@ -43,7 +43,7 @@ gitops completion bash
   -e, --endpoint WEAVE_GITOPS_ENTERPRISE_API_URL   The Weave GitOps Enterprise HTTP API endpoint can be set with WEAVE_GITOPS_ENTERPRISE_API_URL environment variable
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```
@@ -52,4 +52,4 @@ gitops completion bash
 
 * [gitops completion](gitops_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 8-Dec-2022
+###### Auto generated by spf13/cobra on 21-Dec-2022
diff --git a/website/docs/references/cli-reference/gitops_completion_fish.md b/website/docs/references/cli-reference/gitops_completion_fish.md
@@ -34,7 +34,7 @@ gitops completion fish [flags]
   -e, --endpoint WEAVE_GITOPS_ENTERPRISE_API_URL   The Weave GitOps Enterprise HTTP API endpoint can be set with WEAVE_GITOPS_ENTERPRISE_API_URL environment variable
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```
@@ -43,4 +43,4 @@ gitops completion fish [flags]
 
 * [gitops completion](gitops_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 8-Dec-2022
+###### Auto generated by spf13/cobra on 21-Dec-2022
diff --git a/website/docs/references/cli-reference/gitops_completion_powershell.md b/website/docs/references/cli-reference/gitops_completion_powershell.md
@@ -31,7 +31,7 @@ gitops completion powershell [flags]
   -e, --endpoint WEAVE_GITOPS_ENTERPRISE_API_URL   The Weave GitOps Enterprise HTTP API endpoint can be set with WEAVE_GITOPS_ENTERPRISE_API_URL environment variable
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```
@@ -40,4 +40,4 @@ gitops completion powershell [flags]
 
 * [gitops completion](gitops_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 8-Dec-2022
+###### Auto generated by spf13/cobra on 21-Dec-2022
diff --git a/website/docs/references/cli-reference/gitops_completion_zsh.md b/website/docs/references/cli-reference/gitops_completion_zsh.md
@@ -45,7 +45,7 @@ gitops completion zsh [flags]
   -e, --endpoint WEAVE_GITOPS_ENTERPRISE_API_URL   The Weave GitOps Enterprise HTTP API endpoint can be set with WEAVE_GITOPS_ENTERPRISE_API_URL environment variable
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```
@@ -54,4 +54,4 @@ gitops completion zsh [flags]
 
 * [gitops completion](gitops_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 8-Dec-2022
+###### Auto generated by spf13/cobra on 21-Dec-2022
diff --git a/website/docs/references/cli-reference/gitops_create.md b/website/docs/references/cli-reference/gitops_create.md
@@ -27,7 +27,7 @@ gitops create dashboard ww-gitops \
   -e, --endpoint WEAVE_GITOPS_ENTERPRISE_API_URL   The Weave GitOps Enterprise HTTP API endpoint can be set with WEAVE_GITOPS_ENTERPRISE_API_URL environment variable
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```
@@ -37,4 +37,4 @@ gitops create dashboard ww-gitops \
 * [gitops](gitops.md)	 - Weave GitOps
 * [gitops create dashboard](gitops_create_dashboard.md)	 - Create a HelmRepository and HelmRelease to deploy Weave GitOps
 
-###### Auto generated by spf13/cobra on 8-Dec-2022
+###### Auto generated by spf13/cobra on 21-Dec-2022
diff --git a/website/docs/references/cli-reference/gitops_create_dashboard.md b/website/docs/references/cli-reference/gitops_create_dashboard.md
@@ -37,7 +37,7 @@ gitops create dashboard ww-gitops \
       --export                                     Export in YAML format to stdout.
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
       --timeout duration                           The timeout for operations during resource creation. (default 3m0s)
 ```
 

diff --git a/website/docs/references/cli-reference/gitops_get.md b/website/docs/references/cli-reference/gitops_get.md
@@ -26,7 +26,7 @@ echo -n $PASSWORD | gitops get bcrypt-hash
   -e, --endpoint WEAVE_GITOPS_ENTERPRISE_API_URL   The Weave GitOps Enterprise HTTP API endpoint can be set with WEAVE_GITOPS_ENTERPRISE_API_URL environment variable
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```
@@ -37,4 +37,4 @@ echo -n $PASSWORD | gitops get bcrypt-hash
 * [gitops get bcrypt-hash](gitops_get_bcrypt-hash.md)	 - Generates a hashed secret
 * [gitops get config](gitops_get_config.md)	 - Prints out the CLI configuration for Weave GitOps
 
-###### Auto generated by spf13/cobra on 8-Dec-2022
+###### Auto generated by spf13/cobra on 21-Dec-2022
diff --git a/website/docs/references/cli-reference/gitops_get_bcrypt-hash.md b/website/docs/references/cli-reference/gitops_get_bcrypt-hash.md
@@ -27,7 +27,7 @@ echo -n $PASSWORD | gitops get bcrypt-hash
   -e, --endpoint WEAVE_GITOPS_ENTERPRISE_API_URL   The Weave GitOps Enterprise HTTP API endpoint can be set with WEAVE_GITOPS_ENTERPRISE_API_URL environment variable
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```
@@ -36,4 +36,4 @@ echo -n $PASSWORD | gitops get bcrypt-hash
 
 * [gitops get](gitops_get.md)	 - Display one or many Weave GitOps resources
 
-###### Auto generated by spf13/cobra on 8-Dec-2022
+###### Auto generated by spf13/cobra on 21-Dec-2022
diff --git a/website/docs/references/cli-reference/gitops_get_config.md b/website/docs/references/cli-reference/gitops_get_config.md
@@ -26,7 +26,7 @@ gitops get config
   -e, --endpoint WEAVE_GITOPS_ENTERPRISE_API_URL   The Weave GitOps Enterprise HTTP API endpoint can be set with WEAVE_GITOPS_ENTERPRISE_API_URL environment variable
       --insecure-skip-tls-verify                   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
       --kubeconfig string                          Paths to a kubeconfig. Only required if out-of-cluster.
-      --namespace string                           The namespace scope for this operation (default "flux-system")
+  -n, --namespace string                           The namespace scope for this operation (default "flux-system")
   -p, --password WEAVE_GITOPS_PASSWORD             The Weave GitOps Enterprise password for authentication can be set with WEAVE_GITOPS_PASSWORD environment variable
   -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
 ```