Skip to content

Commit

Permalink
Update docs for release 0.12.0
Browse files Browse the repository at this point in the history
  • Loading branch information
weave-gitops-bot committed Dec 8, 2022
1 parent 9229d8f commit 393151f
Show file tree
Hide file tree
Showing 145 changed files with 12,289 additions and 17 deletions.
2 changes: 1 addition & 1 deletion website/docs/installation/weave-gitops.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.10.2/gitops-$(uname)-$(uname -m).tar.gz" | tar xz -C /tmp
curl --silent --location "https://github.com/weaveworks/weave-gitops/releases/download/v0.12.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 @@ -44,4 +44,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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-2022
10 changes: 8 additions & 2 deletions website/docs/references/cli-reference/gitops_beta_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ gitops beta run ./clusters/default/dev --root-dir ./clusters/default
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.
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
```

### Options
Expand All @@ -42,14 +47,15 @@ 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.36.0")
--flux-version string The version of Flux to install. (default "0.37.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-91b93932-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-9229d8f5-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)
```
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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-2022
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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-2022
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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-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 24-Nov-2022
###### Auto generated by spf13/cobra on 8-Dec-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.12.0/_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.11.0
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 @@
"# keep"
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
apiVersion: capi.weave.works/v1alpha1
kind: CAPITemplate
metadata:
name: cluster-template-development
namespace: default
labels:
weave.works/template-type: cluster
spec:
description: A simple CAPD template
params:
- name: CLUSTER_NAME
required: true
description: This is used for the cluster naming.
- name: NAMESPACE
description: Namespace to create the cluster in
- name: KUBERNETES_VERSION
description: Kubernetes version to use for the cluster
options: ["1.19.11", "1.21.1", "1.22.0", "1.23.3"]
- name: CONTROL_PLANE_MACHINE_COUNT
description: Number of control planes
options: ["1", "2", "3"]
- name: WORKER_MACHINE_COUNT
description: Number of worker machines
resourcetemplates:
- apiVersion: gitops.weave.works/v1alpha1
kind: GitopsCluster
metadata:
name: "${CLUSTER_NAME}"
namespace: "${NAMESPACE}"
labels:
weave.works/capi: bootstrap
spec:
capiClusterRef:
name: "${CLUSTER_NAME}"
- apiVersion: cluster.x-k8s.io/v1beta1
kind: Cluster
metadata:
name: "${CLUSTER_NAME}"
namespace: "${NAMESPACE}"
labels:
cni: calico
spec:
clusterNetwork:
pods:
cidrBlocks:
- 192.168.0.0/16
serviceDomain: cluster.local
services:
cidrBlocks:
- 10.128.0.0/12
controlPlaneRef:
apiVersion: controlplane.cluster.x-k8s.io/v1beta1
kind: KubeadmControlPlane
name: "${CLUSTER_NAME}-control-plane"
namespace: "${NAMESPACE}"
infrastructureRef:
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: DockerCluster
name: "${CLUSTER_NAME}"
namespace: "${NAMESPACE}"
- apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: DockerCluster
metadata:
name: "${CLUSTER_NAME}"
namespace: "${NAMESPACE}"
- apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: DockerMachineTemplate
metadata:
name: "${CLUSTER_NAME}-control-plane"
namespace: "${NAMESPACE}"
spec:
template:
spec:
extraMounts:
- containerPath: /var/run/docker.sock
hostPath: /var/run/docker.sock
- apiVersion: controlplane.cluster.x-k8s.io/v1beta1
kind: KubeadmControlPlane
metadata:
name: "${CLUSTER_NAME}-control-plane"
namespace: "${NAMESPACE}"
spec:
kubeadmConfigSpec:
clusterConfiguration:
apiServer:
certSANs:
- localhost
- 127.0.0.1
- 0.0.0.0
controllerManager:
extraArgs:
enable-hostpath-provisioner: "true"
initConfiguration:
nodeRegistration:
criSocket: /var/run/containerd/containerd.sock
kubeletExtraArgs:
cgroup-driver: cgroupfs
eviction-hard: nodefs.available<0%,nodefs.inodesFree<0%,imagefs.available<0%
joinConfiguration:
nodeRegistration:
criSocket: /var/run/containerd/containerd.sock
kubeletExtraArgs:
cgroup-driver: cgroupfs
eviction-hard: nodefs.available<0%,nodefs.inodesFree<0%,imagefs.available<0%
machineTemplate:
infrastructureRef:
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: DockerMachineTemplate
name: "${CLUSTER_NAME}-control-plane"
namespace: "${NAMESPACE}"
replicas: "${CONTROL_PLANE_MACHINE_COUNT}"
version: "${KUBERNETES_VERSION}"
- apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: DockerMachineTemplate
metadata:
name: "${CLUSTER_NAME}-md-0"
namespace: "${NAMESPACE}"
spec:
template:
spec: {}
- apiVersion: bootstrap.cluster.x-k8s.io/v1beta1
kind: KubeadmConfigTemplate
metadata:
name: "${CLUSTER_NAME}-md-0"
namespace: "${NAMESPACE}"
spec:
template:
spec:
joinConfiguration:
nodeRegistration:
kubeletExtraArgs:
cgroup-driver: cgroupfs
eviction-hard: nodefs.available<0%,nodefs.inodesFree<0%,imagefs.available<0%
- apiVersion: cluster.x-k8s.io/v1beta1
kind: MachineDeployment
metadata:
name: "${CLUSTER_NAME}-md-0"
namespace: "${NAMESPACE}"
spec:
clusterName: "${CLUSTER_NAME}"
replicas: "${WORKER_MACHINE_COUNT}"
selector:
matchLabels: null
template:
spec:
bootstrap:
configRef:
apiVersion: bootstrap.cluster.x-k8s.io/v1beta1
kind: KubeadmConfigTemplate
name: "${CLUSTER_NAME}-md-0"
namespace: "${NAMESPACE}"
clusterName: "${CLUSTER_NAME}"
infrastructureRef:
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
kind: DockerMachineTemplate
name: "${CLUSTER_NAME}-md-0"
namespace: "${NAMESPACE}"
version: "${KUBERNETES_VERSION}"
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Cluster Management",
"position": 6
}
Loading

0 comments on commit 393151f

Please sign in to comment.