Skip to content

Commit

Permalink
Update docs for release 0.9.1
Browse files Browse the repository at this point in the history
  • Loading branch information
weave-gitops-bot committed Jul 27, 2022
1 parent 715ccf5 commit d7b8222
Show file tree
Hide file tree
Showing 117 changed files with 11,875 additions and 142 deletions.
16 changes: 9 additions & 7 deletions website/docs/references/cli-reference/gitops.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,19 @@ Command line utility for managing Kubernetes applications via GitOps.
### Options

```
-e, --endpoint string The Weave GitOps Enterprise HTTP API endpoint
-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
--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
-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
-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")
-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 add](gitops_add.md) - Add a new Weave GitOps resource
* [gitops beta](gitops_beta.md) - This component contains unstable or still-in-development functionality
* [gitops check](gitops_check.md) - Validates flux compatibility
* [gitops completion](gitops_completion.md) - Generate the autocompletion script for the specified shell
* [gitops delete](gitops_delete.md) - Delete one or many Weave GitOps resources
Expand All @@ -43,4 +45,4 @@ Command line utility for managing Kubernetes applications via GitOps.
* [gitops upgrade](gitops_upgrade.md) - Upgrade to Weave GitOps Enterprise
* [gitops version](gitops_version.md) - Display gitops version

###### Auto generated by spf13/cobra on 21-Jun-2022
###### Auto generated by spf13/cobra on 27-Jul-2022
13 changes: 7 additions & 6 deletions website/docs/references/cli-reference/gitops_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ gitops add cluster
### Options inherited from parent commands

```
-e, --endpoint string The Weave GitOps Enterprise HTTP API endpoint
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--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
-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")
-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
Expand All @@ -33,4 +34,4 @@ gitops add cluster
* [gitops add profile](gitops_add_profile.md) - Add a profile to a cluster
* [gitops add terraform](gitops_add_terraform.md) - Add a new Terraform resource using a TF template

###### Auto generated by spf13/cobra on 21-Jun-2022
###### Auto generated by spf13/cobra on 27-Jul-2022
15 changes: 8 additions & 7 deletions website/docs/references/cli-reference/gitops_add_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ gitops add cluster [flags]
# Add a new cluster using a CAPI template
gitops add cluster --from-template <template-name> --set key=val
# View a CAPI template populated with parameter values
# View a CAPI template populated with parameter values
# without creating a pull request for it
gitops add cluster --from-template <template-name> --set key=val --dry-run
Expand Down Expand Up @@ -43,15 +43,16 @@ gitops add cluster --from-template <template-name> \
### Options inherited from parent commands

```
-e, --endpoint string The Weave GitOps Enterprise HTTP API endpoint
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--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
-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")
-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 add](gitops_add.md) - Add a new Weave GitOps resource

###### Auto generated by spf13/cobra on 21-Jun-2022
###### Auto generated by spf13/cobra on 27-Jul-2022
13 changes: 7 additions & 6 deletions website/docs/references/cli-reference/gitops_add_profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,16 @@ gitops add profile [flags]
### Options inherited from parent commands

```
-e, --endpoint string The Weave GitOps Enterprise HTTP API endpoint
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--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
-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")
-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 add](gitops_add.md) - Add a new Weave GitOps resource

###### Auto generated by spf13/cobra on 21-Jun-2022
###### Auto generated by spf13/cobra on 27-Jul-2022
13 changes: 7 additions & 6 deletions website/docs/references/cli-reference/gitops_add_terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,16 @@ gitops add terraform --from-template <template-name> --set key=val
### Options inherited from parent commands

```
-e, --endpoint string The Weave GitOps Enterprise HTTP API endpoint
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--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
-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")
-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 add](gitops_add.md) - Add a new Weave GitOps resource

###### Auto generated by spf13/cobra on 21-Jun-2022
###### Auto generated by spf13/cobra on 27-Jul-2022
27 changes: 27 additions & 0 deletions website/docs/references/cli-reference/gitops_beta.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## gitops beta

This component contains unstable or still-in-development functionality

### Options

```
-h, --help help for beta
```

### 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.
--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 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 27-Jul-2022
65 changes: 65 additions & 0 deletions website/docs/references/cli-reference/gitops_beta_run.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
## gitops beta run

Set up an interactive sync between your cluster and your local file system

### Synopsis

This will set up a sync between the cluster in your kubeconfig and the path that you specify on your local filesystem. If you do not have Flux installed on the cluster then this will add it to the cluster automatically. This is a requirement so we can sync the files successfully from your local system onto the cluster. Flux will take care of producing the objects for you.

```
gitops beta run [flags]
```

### Examples

```
# Run the sync on the current working directory
gitops beta run . [flags]
# Run the sync against the dev overlay path
gitops beta run ./deploy/overlays/dev
# Run the sync on the dev directory and forward the port.
# Listen on port 8080 on localhost, forwarding to 5000 in a pod of the service app.
gitops beta run ./dev --port-forward port=8080:5000,resource=svc/app
# Run the sync on the dev directory with a specified root dir.
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 --timeout 3m --port-forward namespace=dev,resource=svc/backend,port=9898:9898
```

### Options

```
--allow-k8s-context string The name of the KubeConfig context to explicitly allow.
--components strings The Flux components to install. (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--components-extra strings Additional Flux components to install.
--context string The name of the kubeconfig context to use
--dashboard-port string GitOps Dashboard port (default "9001")
--flux-version string The version of Flux to install. (default "0.31.0")
-h, --help help for run
--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.
--timeout duration The timeout for operations during GitOps Run. (default 30s)
```

### 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.
--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 beta](gitops_beta.md) - This component contains unstable or still-in-development functionality

13 changes: 7 additions & 6 deletions website/docs/references/cli-reference/gitops_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,16 @@ gitops check
### Options inherited from parent commands

```
-e, --endpoint string The Weave GitOps Enterprise HTTP API endpoint
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--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
-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")
-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

###### Auto generated by spf13/cobra on 21-Jun-2022
###### Auto generated by spf13/cobra on 27-Jul-2022
13 changes: 7 additions & 6 deletions website/docs/references/cli-reference/gitops_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,12 @@ See each sub-command's help for details on how to use the generated script.
### Options inherited from parent commands

```
-e, --endpoint string The Weave GitOps Enterprise HTTP API endpoint
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--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
-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")
-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
Expand All @@ -32,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-Jun-2022
###### Auto generated by spf13/cobra on 27-Jul-2022
Loading

0 comments on commit d7b8222

Please sign in to comment.