Update docs for release 0.31.2

weaveworks · Aug 30, 2023 · 0fb6670 · 0fb6670
1 parent e2a60cf
commit 0fb6670
Show file tree

Hide file tree

Showing 223 changed files with 18,909 additions and 28 deletions.
diff --git a/website/docs/open-source/getting-started/install-OSS.mdx b/website/docs/open-source/getting-started/install-OSS.mdx
@@ -126,7 +126,7 @@ import TabItem from "@theme/TabItem";
 <TabItem value="curl" label="curl">
 
 ```bash
-curl --silent --location "https://github.com/weaveworks/weave-gitops/releases/download/v0.30.0/gitops-$(uname)-$(uname -m).tar.gz" | tar xz -C /tmp
+curl --silent --location "https://github.com/weaveworks/weave-gitops/releases/download/v0.31.2/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
@@ -50,4 +50,4 @@ Command line utility for managing Kubernetes applications via GitOps.
 * [gitops suspend](gitops_suspend.md)	 - Suspend a resource
 * [gitops version](gitops_version.md)	 - Display gitops version
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_beta.md b/website/docs/references/cli-reference/gitops_beta.md
@@ -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 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_beta_run.md b/website/docs/references/cli-reference/gitops_beta_run.md
@@ -60,7 +60,7 @@ gitops beta run ./charts/podinfo --timeout 3m --port-forward namespace=flux-syst
       --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-b87733dd-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-e2a60cfd-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.

diff --git a/website/docs/references/cli-reference/gitops_check.md b/website/docs/references/cli-reference/gitops_check.md
@@ -36,4 +36,4 @@ gitops check
 
 * [gitops](gitops.md)	 - Weave GitOps
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_completion.md b/website/docs/references/cli-reference/gitops_completion.md
@@ -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 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_completion_bash.md b/website/docs/references/cli-reference/gitops_completion_bash.md
@@ -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 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_completion_fish.md b/website/docs/references/cli-reference/gitops_completion_fish.md
@@ -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 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_completion_powershell.md b/website/docs/references/cli-reference/gitops_completion_powershell.md
@@ -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 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_completion_zsh.md b/website/docs/references/cli-reference/gitops_completion_zsh.md
@@ -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 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_create.md b/website/docs/references/cli-reference/gitops_create.md
@@ -46,4 +46,4 @@ gitops create terraform my-resource \
 * [gitops create dashboard](gitops_create_dashboard.md)	 - Create a HelmRepository and HelmRelease to deploy Weave GitOps
 * [gitops create terraform](gitops_create_terraform.md)	 - Create a Terraform object
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_create_terraform.md b/website/docs/references/cli-reference/gitops_create_terraform.md
@@ -50,4 +50,4 @@ gitops create terraform -n default my-resource --source GitRepository/my-project
 
 * [gitops create](gitops_create.md)	 - Creates a resource
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_delete.md b/website/docs/references/cli-reference/gitops_delete.md
@@ -24,4 +24,4 @@ Delete a resource
 * [gitops](gitops.md)	 - Weave GitOps
 * [gitops delete terraform](gitops_delete_terraform.md)	 - Delete a Terraform object
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_delete_terraform.md b/website/docs/references/cli-reference/gitops_delete_terraform.md
@@ -38,4 +38,4 @@ gitops delete terraform -n default my-resource
 
 * [gitops delete](gitops_delete.md)	 - Delete a resource
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_get.md b/website/docs/references/cli-reference/gitops_get.md
@@ -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 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_get_bcrypt-hash.md b/website/docs/references/cli-reference/gitops_get_bcrypt-hash.md
@@ -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 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_logs.md b/website/docs/references/cli-reference/gitops_logs.md
@@ -24,4 +24,4 @@ Get logs for a resource
 * [gitops](gitops.md)	 - Weave GitOps
 * [gitops logs terraform](gitops_logs_terraform.md)	 - Get the runner logs of a Terraform object
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_logs_terraform.md b/website/docs/references/cli-reference/gitops_logs_terraform.md
@@ -38,4 +38,4 @@ gitops logs terraform --namespace flux-system my-resource
 
 * [gitops logs](gitops_logs.md)	 - Get logs for a resource
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_remove.md b/website/docs/references/cli-reference/gitops_remove.md
@@ -24,4 +24,4 @@ Remove various components of Weave GitOps
 * [gitops](gitops.md)	 - Weave GitOps
 * [gitops remove run](gitops_remove_run.md)	 - Remove GitOps Run sessions
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_replan.md b/website/docs/references/cli-reference/gitops_replan.md
@@ -33,4 +33,4 @@ gitops replan terraform --namespace flux-system my-resource
 * [gitops](gitops.md)	 - Weave GitOps
 * [gitops replan terraform](gitops_replan_terraform.md)	 - Trigger replan for a Terraform object
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_replan_terraform.md b/website/docs/references/cli-reference/gitops_replan_terraform.md
@@ -38,4 +38,4 @@ gitops replan terraform --namespace flux-system my-resource
 
 * [gitops replan](gitops_replan.md)	 - Replan a resource
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_resume.md b/website/docs/references/cli-reference/gitops_resume.md
@@ -33,4 +33,4 @@ gitops resume terraform --namespace flux-system my-resource
 * [gitops](gitops.md)	 - Weave GitOps
 * [gitops resume terraform](gitops_resume_terraform.md)	 - Resume a Terraform object
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_resume_terraform.md b/website/docs/references/cli-reference/gitops_resume_terraform.md
@@ -38,4 +38,4 @@ gitops resume terraform --namespace flux-system my-resource
 
 * [gitops resume](gitops_resume.md)	 - Resume a resource
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_run.md b/website/docs/references/cli-reference/gitops_run.md
@@ -60,7 +60,7 @@ gitops beta run ./charts/podinfo --timeout 3m --port-forward namespace=flux-syst
       --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-b87733dd-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-e2a60cfd-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.

diff --git a/website/docs/references/cli-reference/gitops_set.md b/website/docs/references/cli-reference/gitops_set.md
@@ -32,4 +32,4 @@ gitops set config analytics true
 * [gitops](gitops.md)	 - Weave GitOps
 * [gitops set config](gitops_set_config.md)	 - Set the CLI configuration for Weave GitOps
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_suspend.md b/website/docs/references/cli-reference/gitops_suspend.md
@@ -33,4 +33,4 @@ gitops resume terraform --namespace flux-system my-resource
 * [gitops](gitops.md)	 - Weave GitOps
 * [gitops suspend terraform](gitops_suspend_terraform.md)	 - Suspend a Terraform object
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_suspend_terraform.md b/website/docs/references/cli-reference/gitops_suspend_terraform.md
@@ -38,4 +38,4 @@ gitops suspend terraform --namespace flux-system my-resource
 
 * [gitops suspend](gitops_suspend.md)	 - Suspend a resource
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/docs/references/cli-reference/gitops_version.md b/website/docs/references/cli-reference/gitops_version.md
@@ -27,4 +27,4 @@ gitops version [flags]
 
 * [gitops](gitops.md)	 - Weave GitOps
 
-###### Auto generated by spf13/cobra on 16-Aug-2023
+###### Auto generated by spf13/cobra on 30-Aug-2023
diff --git a/website/versioned_docs/version-0.31.2/_components/CurlCodeBlock.jsx b/website/versioned_docs/version-0.31.2/_components/CurlCodeBlock.jsx
@@ -0,0 +1,24 @@
+import React from "react";
+
+import CodeBlock from "@theme/CodeBlock";
+import BrowserOnly from "@docusaurus/BrowserOnly";
+
+export default function CurlCodeBlock({ localPath, hostedPath, content }) {
+  return (
+    <>
+      <BrowserOnly>
+        {() => (
+          <CodeBlock className="language-bash">
+            curl -o {localPath} {window.location.protocol}
+            //{window.location.host}
+            {hostedPath}
+          </CodeBlock>
+        )}
+      </BrowserOnly>
+
+      <CodeBlock title={localPath} className="language-yaml">
+        {content}
+      </CodeBlock>
+    </>
+  );
+}
diff --git a/website/versioned_docs/version-0.31.2/_components/TierLabel.jsx b/website/versioned_docs/version-0.31.2/_components/TierLabel.jsx
@@ -0,0 +1,20 @@
+import React from "react";
+import Link from "@docusaurus/Link";
+import useGlobalData from "@docusaurus/useGlobalData";
+
+const containerStyle = {
+  fontSize: 16,
+  marginLeft: 4,
+  fontVariant: "all-small-caps",
+};
+
+export default function TierLabel({ tiers }) {
+  return (
+    <Link
+      title={`This feature is a available on ${tiers}.`}
+      style={containerStyle}
+    >
+      {tiers}
+    </Link>
+  );
+}
diff --git a/website/versioned_docs/version-0.31.2/_components/_alpha_warning.mdx b/website/versioned_docs/version-0.31.2/_components/_alpha_warning.mdx
@@ -0,0 +1,9 @@
+
+:::caution
+
+**This feature is in alpha and certain aspects will change**
+
+We're very excited for people to use this feature.
+However, please note that changes in the API, behaviour and security will evolve.
+The feature is suitable to use in controlled testing environments.
+:::