Update docs for release 0.14.1

weaveworks · Jan 4, 2023 · 2a3c0ce · 2a3c0ce
1 parent 317e7b7
commit 2a3c0ce
Show file tree

Hide file tree

Showing 172 changed files with 13,795 additions and 17 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.13.0/gitops-$(uname)-$(uname -m).tar.gz" | tar xz -C /tmp
+curl --silent --location "https://github.com/weaveworks/weave-gitops/releases/download/v0.14.1/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
@@ -39,9 +39,14 @@ Command line utility for managing Kubernetes applications via GitOps.
 * [gitops check](gitops_check.md)	 - Validates flux compatibility
 * [gitops completion](gitops_completion.md)	 - Generate the autocompletion script for the specified shell
 * [gitops create](gitops_create.md)	 - Creates a resource
+* [gitops delete](gitops_delete.md)	 - Delete a resource
 * [gitops get](gitops_get.md)	 - Display one or many Weave GitOps resources
+* [gitops logs](gitops_logs.md)	 - Get logs for a resource
 * [gitops remove](gitops_remove.md)	 - Remove various components of Weave GitOps
+* [gitops replan](gitops_replan.md)	 - Replan a resource
+* [gitops resume](gitops_resume.md)	 - Resume a resource
 * [gitops set](gitops_set.md)	 - Sets one or many Weave GitOps CLI configs or resources
+* [gitops suspend](gitops_suspend.md)	 - Suspend a resource
 * [gitops version](gitops_version.md)	 - Display gitops version
 
-###### Auto generated by spf13/cobra on 21-Dec-2022
+###### Auto generated by spf13/cobra on 4-Jan-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 21-Dec-2022
+###### Auto generated by spf13/cobra on 4-Jan-2023
diff --git a/website/docs/references/cli-reference/gitops_beta_run.md b/website/docs/references/cli-reference/gitops_beta_run.md
@@ -30,9 +30,14 @@ gitops beta run ./clusters/default/dev --root-dir ./clusters/default
 # Run the sync on the podinfo demo.
 git clone https://github.com/stefanprodan/podinfo
 cd podinfo
+gitops beta run ./deploy/overlays/dev --no-session --timeout 3m --port-forward namespace=dev,resource=svc/backend,port=9898:9898
+
+# Run the sync on the podinfo demo in the session mode.
+git clone https://github.com/stefanprodan/podinfo
+cd podinfo
 gitops beta run ./deploy/overlays/dev --timeout 3m --port-forward namespace=dev,resource=svc/backend,port=9898:9898
 
-# Run the sync on the podinfo Helm chart. Please note that file Chart.yaml must exist in the directory.
+# Run the sync on the podinfo Helm chart, in the session mode. Please note that file Chart.yaml must exist in the directory.
 git clone https://github.com/stefanprodan/podinfo
 cd podinfo
 gitops beta run ./chart/podinfo --timeout 3m --port-forward namespace=flux-system,resource=svc/run-dev-helm-podinfo,port=9898:9898
@@ -53,7 +58,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-b31086e4-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-317e7b73-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 21-Dec-2022
+###### Auto generated by spf13/cobra on 4-Jan-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 21-Dec-2022
+###### Auto generated by spf13/cobra on 4-Jan-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 21-Dec-2022
+###### Auto generated by spf13/cobra on 4-Jan-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 21-Dec-2022
+###### Auto generated by spf13/cobra on 4-Jan-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 21-Dec-2022
+###### Auto generated by spf13/cobra on 4-Jan-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 21-Dec-2022
+###### Auto generated by spf13/cobra on 4-Jan-2023
diff --git a/website/docs/references/cli-reference/gitops_create.md b/website/docs/references/cli-reference/gitops_create.md
@@ -10,6 +10,14 @@ Creates a resource
 gitops create dashboard ww-gitops \
   --password=$PASSWORD \
   --export > ./clusters/my-cluster/weave-gitops-dashboard.yaml
+
+# Create a Terraform object
+gitops create terraform my-resource \
+  -n my-namespace \
+  --source GitRepository/my-project \
+  --path ./terraform \
+  --interval 1m \
+  --export > ./clusters/my-cluster/infra/terraform-my-resource.yaml
 		
 ```
 
@@ -36,5 +44,6 @@ 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
+* [gitops create terraform](gitops_create_terraform.md)	 - Create a Terraform object
 
-###### Auto generated by spf13/cobra on 21-Dec-2022
+###### Auto generated by spf13/cobra on 4-Jan-2023
diff --git a/website/docs/references/cli-reference/gitops_create_terraform.md b/website/docs/references/cli-reference/gitops_create_terraform.md
@@ -0,0 +1,52 @@
+## gitops create terraform
+
+Create a Terraform object
+
+### Synopsis
+
+Create a Terraform object
+
+```
+gitops create terraform [flags]
+```
+
+### Examples
+
+```
+
+# Create a Terraform resource in the default namespace
+gitops create terraform -n default my-resource --source GitRepository/my-project --path ./terraform --interval 15m
+
+# Create and export a Terraform resource manifest to the standard output
+gitops create terraform -n default my-resource --source GitRepository/my-project --path ./terraform --interval 15m --export
+
+```
+
+### Options
+
+```
+      --context string    The name of the kubeconfig context to use
+  -h, --help              help for terraform
+      --interval string   Interval at which the Terraform configuration should be applied
+      --path string       Path to the Terraform configuration
+      --source string     Source of the Terraform configuration
+```
+
+### Options inherited from parent commands
+
+```
+  -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
+      --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.
+  -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
+      --timeout duration                           The timeout for operations during resource creation. (default 3m0s)
+  -u, --username WEAVE_GITOPS_USERNAME             The Weave GitOps Enterprise username for authentication can be set with WEAVE_GITOPS_USERNAME environment variable
+```
+
+### SEE ALSO
+
+* [gitops create](gitops_create.md)	 - Creates a resource
+
+###### Auto generated by spf13/cobra on 4-Jan-2023
diff --git a/website/docs/references/cli-reference/gitops_delete.md b/website/docs/references/cli-reference/gitops_delete.md
@@ -0,0 +1,27 @@
+## gitops delete
+
+Delete a resource
+
+### Options
+
+```
+  -h, --help   help for delete
+```
+
+### Options inherited from parent commands
+
+```
+  -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.
+  -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
+```
+
+### SEE ALSO
+
+* [gitops](gitops.md)	 - Weave GitOps
+* [gitops delete terraform](gitops_delete_terraform.md)	 - Delete a Terraform object
+
+###### Auto generated by spf13/cobra on 4-Jan-2023
diff --git a/website/docs/references/cli-reference/gitops_delete_terraform.md b/website/docs/references/cli-reference/gitops_delete_terraform.md
@@ -0,0 +1,40 @@
+## gitops delete terraform
+
+Delete a Terraform object
+
+```
+gitops delete terraform [flags]
+```
+
+### Examples
+
+```
+
+# Delete a Terraform resource in the default namespace
+gitops delete terraform -n default my-resource
+
+```
+
+### Options
+
+```
+      --context string   The name of the kubeconfig context to use
+  -h, --help             help for terraform
+```
+
+### Options inherited from parent commands
+
+```
+  -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.
+  -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
+```
+
+### SEE ALSO
+
+* [gitops delete](gitops_delete.md)	 - Delete a resource
+
+###### Auto generated by spf13/cobra on 4-Jan-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 21-Dec-2022
+###### Auto generated by spf13/cobra on 4-Jan-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 21-Dec-2022
+###### Auto generated by spf13/cobra on 4-Jan-2023
diff --git a/website/docs/references/cli-reference/gitops_logs.md b/website/docs/references/cli-reference/gitops_logs.md
@@ -0,0 +1,27 @@
+## gitops logs
+
+Get logs for a resource
+
+### Options
+
+```
+  -h, --help   help for logs
+```
+
+### Options inherited from parent commands
+
+```
+  -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.
+  -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
+```
+
+### SEE ALSO
+
+* [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 4-Jan-2023
diff --git a/website/docs/references/cli-reference/gitops_logs_terraform.md b/website/docs/references/cli-reference/gitops_logs_terraform.md
@@ -0,0 +1,40 @@
+## gitops logs terraform
+
+Get the runner logs of a Terraform object
+
+```
+gitops logs terraform [flags]
+```
+
+### Examples
+
+```
+
+# Get the runner logs of a Terraform object in the "flux-system" namespace
+gitops logs terraform --namespace flux-system my-resource
+
+```
+
+### Options
+
+```
+      --context string   The name of the kubeconfig context to use
+  -h, --help             help for terraform
+```
+
+### Options inherited from parent commands
+
+```
+  -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.
+  -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
+```
+
+### SEE ALSO
+
+* [gitops logs](gitops_logs.md)	 - Get logs for a resource
+
+###### Auto generated by spf13/cobra on 4-Jan-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 21-Dec-2022
+###### Auto generated by spf13/cobra on 4-Jan-2023
diff --git a/website/docs/references/cli-reference/gitops_replan.md b/website/docs/references/cli-reference/gitops_replan.md
@@ -0,0 +1,36 @@
+## gitops replan
+
+Replan a resource
+
+### Examples
+
+```
+
+# Replan the Terraform plan of a Terraform object from the "flux-system" namespace
+gitops replan terraform --namespace flux-system my-resource
+
+```
+
+### Options
+
+```
+  -h, --help   help for replan
+```
+
+### Options inherited from parent commands
+
+```
+  -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.
+  -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
+```
+
+### SEE ALSO
+
+* [gitops](gitops.md)	 - Weave GitOps
+* [gitops replan terraform](gitops_replan_terraform.md)	 - Trigger replan for a Terraform object
+
+###### Auto generated by spf13/cobra on 4-Jan-2023