Skip to content

Commit

Permalink
Update docs for release 0.35.0
Browse files Browse the repository at this point in the history
  • Loading branch information
weave-gitops-bot committed Oct 25, 2023
1 parent 31cecfe commit 82b74ee
Show file tree
Hide file tree
Showing 234 changed files with 19,922 additions and 28 deletions.
2 changes: 1 addition & 1 deletion website/docs/open-source/getting-started/install-OSS.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.34.0/gitops-$(uname)-$(uname -m).tar.gz" | tar xz -C /tmp
curl --silent --location "https://github.com/weaveworks/weave-gitops/releases/download/v0.35.0/gitops-$(uname)-$(uname -m).tar.gz" | tar xz -C /tmp
sudo mv /tmp/gitops /usr/local/bin
gitops version
```
Expand Down
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
3 changes: 2 additions & 1 deletion website/docs/references/cli-reference/gitops_beta_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,12 @@ 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-5559b779-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-31cecfe3-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.
--timeout duration The timeout for operations during GitOps Run. (default 5m0s)
--values strings Local path to values.yaml files for HelmRelease, also accepts comma-separated values.
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ gitops check

* [gitops](gitops.md) - Weave GitOps

###### Auto generated by spf13/cobra on 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ gitops create dashboard ww-gitops \
-h, --help help for dashboard
--password string The password of the dashboard admin user.
--username string The username of the dashboard admin user. (default "admin")
--values strings Local path to values.yaml files for HelmRelease, also accepts comma-separated values.
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_replan.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_resume.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
3 changes: 2 additions & 1 deletion website/docs/references/cli-reference/gitops_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,12 @@ 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-5559b779-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-31cecfe3-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.
--timeout duration The timeout for operations during GitOps Run. (default 5m0s)
--values strings Local path to values.yaml files for HelmRelease, also accepts comma-separated values.
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_set.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_suspend.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
Original file line number Diff line number Diff line change
Expand Up @@ -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 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
2 changes: 1 addition & 1 deletion website/docs/references/cli-reference/gitops_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ gitops version [flags]

* [gitops](gitops.md) - Weave GitOps

###### Auto generated by spf13/cobra on 11-Oct-2023
###### Auto generated by spf13/cobra on 25-Oct-2023
Original file line number Diff line number Diff line change
@@ -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>
</>
);
}
20 changes: 20 additions & 0 deletions website/versioned_docs/version-0.35.0/_components/TierLabel.jsx
Original file line number Diff line number Diff line change
@@ -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>
);
}
Original file line number Diff line number Diff line change
@@ -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.
:::
Loading

0 comments on commit 82b74ee

Please sign in to comment.