Skip to content

Commit

Permalink
Update docs for release 0.10.1
Browse files Browse the repository at this point in the history
  • Loading branch information
weave-gitops-bot committed Oct 28, 2022
1 parent 1ec8b90 commit 029092a
Show file tree
Hide file tree
Showing 129 changed files with 10,615 additions and 20 deletions.
2 changes: 1 addition & 1 deletion website/docs/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Windows support is a [planned enhancement](https://github.com/weaveworks/weave-g
To install:

```console
curl --silent --location "https://github.com/weaveworks/weave-gitops/releases/download/v0.10.0/gitops-$(uname)-$(uname -m).tar.gz" | tar xz -C /tmp
curl --silent --location "https://github.com/weaveworks/weave-gitops/releases/download/v0.10.1/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 @@ -43,4 +43,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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
4 changes: 2 additions & 2 deletions website/docs/references/cli-reference/gitops_beta_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ gitops beta run ./deploy/overlays/dev --timeout 3m --port-forward namespace=dev,
--context string The name of the kubeconfig context to use
--dashboard-hashed-password string GitOps Dashboard password in BCrypt hash format
--dashboard-port string GitOps Dashboard port (default "9001")
--flux-version string The version of Flux to install. (default "0.35.0")
--flux-version string The version of Flux to install. (default "0.36.0")
-h, --help help for run
--no-bootstrap Disable bootstrapping at shutdown.
--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-8f92b79a-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-1ec8b90e-dirty")
--session-namespace string Specify the namespace of the session. (default "default")
--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)
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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
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 @@ -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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ gitops create dashboard ww-gitops \
### Options

```
--context string The name of the kubeconfig context to use
-h, --help help for dashboard
--context string The name of the kubeconfig context to use
-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")
```

### Options inherited from parent commands
Expand All @@ -36,9 +38,7 @@ gitops create dashboard ww-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
--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
Expand Down
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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
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 13-Oct-2022
###### Auto generated by spf13/cobra on 28-Oct-2022
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>
</>
);
}
32 changes: 32 additions & 0 deletions website/versioned_docs/version-0.10.1/_components/TierLabel.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import React from "react";
import Link from "@docusaurus/Link";
import useGlobalData from "@docusaurus/useGlobalData";

const containerStyle = {
fontSize: 16,
marginLeft: 4,
fontVariant: "all-small-caps",
};

// This determines the current version of the docs you're looking at
// E.g. /docs/next or /docs/0.2.5
const getCurrentVersionPath = () => {
const { "docusaurus-plugin-content-docs": data } = useGlobalData();
const currentVersion = data?.default?.versions?.find(
(v) => v.name === "current"
);
// Fallback to /docs just in case. Not sure if this is async etc.
return currentVersion?.path || "/docs";
};

export default function TierLabel({ tiers }) {
return (
<Link
to={`${getCurrentVersionPath()}/enterprise/intro`}
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,48 @@
apiVersion: source.toolkit.fluxcd.io/v1beta2
kind: HelmRepository
metadata:
name: weave-gitops-enterprise-charts
namespace: flux-system
spec:
interval: 60m
secretRef:
name: weave-gitops-enterprise-credentials
url: https://charts.dev.wkp.weave.works/releases/charts-v3
---
apiVersion: helm.toolkit.fluxcd.io/v2beta1
kind: HelmRelease
metadata:
name: weave-gitops-enterprise
namespace: flux-system
spec:
chart:
spec:
interval: 65m
chart: mccp
sourceRef:
kind: HelmRepository
name: weave-gitops-enterprise-charts
namespace: flux-system
version: 0.9.5
install:
crds: CreateReplace
upgrade:
crds: CreateReplace
interval: 50m
values:
# -- Configure TLS settings if needed
# tls:
# -- Can be disabled if TLS is handled by a user-provided ingress controller
# enabled: true
# -- optionally specify a TLS secret
# secretName: null
config:
capi:
repositoryURL: https://github.com/$GITHUB_USER/fleet-infra
# -- Can be changed depending on your git repo structure
# repositoryPath: ./clusters/management/clusters
# repositoryClustersPath: ./cluster
git:
type: github
# -- Change if using on-prem github/gitlab
# hostname: https://github.com
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Cluster Management",
"position": 6
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Add Applications
sidebar_position: 7
hide_title: true
---

import TierLabel from "../\_components/TierLabel";

# Add Applications <TierLabel tiers="enterprise" />

It is always useful to be able to install software packages to bootstrapped cluster. Weave GitOps Enterprise enables this by adding applications to target cluster through the UI by adding a kustomization or a helmrelease. Here is how we can do that:

### Add an Applications to a target cluster (bootstrapped)

1. At the applications page you can now find an add applications button.

![Profiles Selection](./img/add-application-btn.png)

2. A form will show up to you so that you can select the target cluster that you want to add application to.

![Profiles Selection](./img/add-application-form.png)

3. Then you will be able to select either source type of git repository or helm repository from the selected cluster.

![Profiles Selection](./img/add-application-select-source.png)

4. If you select git repository as source type, you will be abl to add application from kustomization.

![Profiles Selection](./img/add-application-kustomization.png)

5. If you select helm repository as source type, you will be abl to add application from helm release. And if you had selected the profiles Helm chart repository URL, you will be able to select a profile from the Profiles list that have been created in at [Profiles](profiles.mdx).

![Profiles Selection](./img/add-application-helm-release.png)

6. Last but not least now you will be able to create a pr to the target cluster. And you can see a new PR at you GitOps repository.
Loading

0 comments on commit 029092a

Please sign in to comment.