Skip to content

Commit

Permalink
Add helm-controller docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@stefanprodan
stefanprodan committed Jul 14, 2020
1 parent 02521b6 commit a96777d
Show file tree
Hide file tree
Showing 38 changed files with 77 additions and 35 deletions.
13 changes: 12 additions & 1 deletion .github/workflows/docs.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,28 @@ jobs:
uses: actions/checkout@v1
- name: Copy assets
run: |
cp install/tk.sh docs/install.sh
# source-controller CRDs
curl https://raw.githubusercontent.com/fluxcd/source-controller/master/docs/api/source.md > docs/components/source/api.md
curl https://raw.githubusercontent.com/fluxcd/source-controller/master/docs/spec/v1alpha1/gitrepositories.md > docs/components/source/gitrepositories.md
curl https://raw.githubusercontent.com/fluxcd/source-controller/master/docs/spec/v1alpha1/helmrepositories.md > docs/components/source/helmrepositories.md
# kustomize-controller CRDs
curl https://raw.githubusercontent.com/fluxcd/kustomize-controller/master/docs/api/kustomize.md > docs/components/kustomize/api.md
curl https://raw.githubusercontent.com/fluxcd/kustomize-controller/master/docs/spec/v1alpha1/kustomization.md > docs/components/kustomize/kustomization.md
# helm-controller CRDs
curl https://raw.githubusercontent.com/fluxcd/helm-controller/master/docs/api/helmrelease.md > docs/components/helm/api.md
curl https://raw.githubusercontent.com/fluxcd/helm-controller/master/docs/spec/v1alpha1/helmreleases.md > docs/components/helm/helmreleases.md
# notification-controller CRDs
curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/api/notification.md > docs/components/notification/api.md
curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/spec/v1alpha1/event.md > docs/components/notification/event.md
curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/spec/v1alpha1/alert.md > docs/components/notification/alert.md
curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/spec/v1alpha1/provider.md > docs/components/notification/provider.md
curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/spec/v1alpha1/receiver.md > docs/components/notification/receiver.md
# install script
cp install/tk.sh docs/install.sh
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
Expand Down
Binary file added docs/_files/helm-controller.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/cmd/tk.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
### Options

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
-h, --help help for tk
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_bootstrap.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The bootstrap sub-commands bootstrap the toolkit components on the targeted Git
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_bootstrap_github.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ tk bootstrap github [flags]
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_bootstrap_gitlab.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ tk bootstrap gitlab [flags]
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_check.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ tk check [flags]
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_completion.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To configure your bash shell to load completions for each session add to your ba
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_create.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The create sub-commands generate sources and resources.
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_create_kustomization.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ tk create kustomization [name] [flags]
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_create_source.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The create source sub-commands generate sources.
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_create_source_git.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ tk create source git [name] [flags]
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_delete.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The delete sub-commands delete sources and resources.
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_delete_kustomization.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ tk delete kustomization [name] [flags]
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
-s, --silent delete resource without asking for confirmation
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_delete_source.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The delete source sub-commands delete sources.
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
-s, --silent delete resource without asking for confirmation
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_delete_source_git.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ tk delete source git [name] [flags]
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
-s, --silent delete resource without asking for confirmation
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_export.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The export sub-commands export resources in YAML format.
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_export_kustomization.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ tk export kustomization [name] [flags]

```
--all select all resources
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_export_source.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The export source sub-commands export sources in YAML format.

```
--all select all resources
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_export_source_git.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ tk export source git [name] [flags]

```
--all select all resources
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_get.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The get sub-commands print the statuses of sources and resources.
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_get_kustomizations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ tk get kustomizations [flags]
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_get_sources.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The get source sub-commands print the statuses of the sources.
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_get_sources_git.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ tk get sources git [flags]
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ tk install [flags]
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_resume.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The resume sub-commands resume a suspended resource.
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_resume_kustomization.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ tk resume kustomization [name] [flags]
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tk_suspend.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The suspend sub-commands suspend the reconciliation of a resource.
### Options inherited from parent commands

```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
--namespace string the namespace scope for this operation (default "gitops-system")
--timeout duration timeout for this operation (default 5m0s)
Expand Down

0 comments on commit a96777d

Please sign in to comment.