1
0
mirror of synced 2026-02-06 19:05:55 +00:00

Tidy up command descriptions

Rewordings and removal of superfluous newlines.

Signed-off-by: Hidde Beydals <hello@hidde.co>
This commit is contained in:
Hidde Beydals
2021-03-26 10:16:38 +01:00
parent 1b2ffad2f1
commit 236ffd1767
179 changed files with 161 additions and 354 deletions

View File

@@ -7,6 +7,7 @@ Command line utility for assembling Kubernetes CD pipelines
### Synopsis
Command line utility for assembling Kubernetes CD pipelines the GitOps way.
### Examples
@@ -18,7 +19,7 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
# Install the latest version of Flux
flux install --version=master
# Create a source from a public Git repository
# Create a source for a public Git repository
flux create source git webapp-latest \
--url=https://github.com/stefanprodan/podinfo \
--branch=master \
@@ -64,7 +65,6 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
# Uninstall Flux and delete CRDs
flux uninstall
```
### Options

View File

@@ -23,27 +23,26 @@ flux bootstrap github [flags]
# Create a GitHub personal access token and export it as an env var
export GITHUB_TOKEN=<my-token>
# Run bootstrap for a private repo owned by a GitHub organization
flux bootstrap github --owner=<organization> --repository=<repo name>
# Run bootstrap for a private repository owned by a GitHub organization
flux bootstrap github --owner=<organization> --repository=<repository name>
# Run bootstrap for a private repo and assign organization teams to it
flux bootstrap github --owner=<organization> --repository=<repo name> --team=<team1 slug> --team=<team2 slug>
# Run bootstrap for a private repository and assign organization teams to it
flux bootstrap github --owner=<organization> --repository=<repository name> --team=<team1 slug> --team=<team2 slug>
# Run bootstrap for a repository path
flux bootstrap github --owner=<organization> --repository=<repo name> --path=dev-cluster
flux bootstrap github --owner=<organization> --repository=<repository name> --path=dev-cluster
# Run bootstrap for a public repository on a personal account
flux bootstrap github --owner=<user> --repository=<repo name> --private=false --personal=true
flux bootstrap github --owner=<user> --repository=<repository name> --private=false --personal=true
# Run bootstrap for a private repo hosted on GitHub Enterprise using SSH auth
flux bootstrap github --owner=<organization> --repository=<repo name> --hostname=<domain> --ssh-hostname=<domain>
# Run bootstrap for a private repository hosted on GitHub Enterprise using SSH auth
flux bootstrap github --owner=<organization> --repository=<repository name> --hostname=<domain> --ssh-hostname=<domain>
# Run bootstrap for a private repo hosted on GitHub Enterprise using HTTPS auth
flux bootstrap github --owner=<organization> --repository=<repo name> --hostname=<domain> --token-auth
# Run bootstrap for a an existing repository with a branch named main
flux bootstrap github --owner=<organization> --repository=<repo name> --branch=main
# Run bootstrap for a private repository hosted on GitHub Enterprise using HTTPS auth
flux bootstrap github --owner=<organization> --repository=<repository name> --hostname=<domain> --token-auth
# Run bootstrap for an existing repository with a branch named main
flux bootstrap github --owner=<organization> --repository=<repository name> --branch=main
```
### Options

View File

@@ -23,24 +23,23 @@ flux bootstrap gitlab [flags]
# Create a GitLab API token and export it as an env var
export GITLAB_TOKEN=<my-token>
# Run bootstrap for a private repo using HTTPS token authentication
flux bootstrap gitlab --owner=<group> --repository=<repo name> --token-auth
# Run bootstrap for a private repository using HTTPS token authentication
flux bootstrap gitlab --owner=<group> --repository=<repository name> --token-auth
# Run bootstrap for a private repo using SSH authentication
flux bootstrap gitlab --owner=<group> --repository=<repo name>
# Run bootstrap for a private repository using SSH authentication
flux bootstrap gitlab --owner=<group> --repository=<repository name>
# Run bootstrap for a repository path
flux bootstrap gitlab --owner=<group> --repository=<repo name> --path=dev-cluster
flux bootstrap gitlab --owner=<group> --repository=<repository name> --path=dev-cluster
# Run bootstrap for a public repository on a personal account
flux bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal --token-auth
flux bootstrap gitlab --owner=<user> --repository=<repository name> --private=false --personal --token-auth
# Run bootstrap for a private repo hosted on a GitLab server
flux bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain> --token-auth
# Run bootstrap for a private repository hosted on a GitLab server
flux bootstrap gitlab --owner=<group> --repository=<repository name> --hostname=<domain> --token-auth
# Run bootstrap for a an existing repository with a branch named main
flux bootstrap gitlab --owner=<organization> --repository=<repo name> --branch=main --token-auth
flux bootstrap gitlab --owner=<organization> --repository=<repository name> --branch=main --token-auth
```
### Options

View File

@@ -22,7 +22,6 @@ flux check [flags]
# Run installation checks
flux check
```
### Options

View File

@@ -20,7 +20,6 @@ To configure your bash shell to load completions for each session add to your ba
# ~/.bashrc or ~/.profile
command -v flux >/dev/null && . <(flux completion bash)
```
### Options

View File

@@ -17,7 +17,6 @@ To configure your fish shell to load completions for each session write this scr
flux completion fish > ~/.config/fish/completions/flux.fish
See http://fishshell.com/docs/current/index.html#completion-own for more details
```
### Options

View File

@@ -27,7 +27,6 @@ Linux:
cd "${XDG_CONFIG_HOME:-"$HOME/.config/"}/powershell/modules"
flux completion >> flux-completions.ps1
```
### Options

View File

@@ -28,7 +28,6 @@ flux completion zsh > _flux
mv _flux ~/.oh-my-zsh/completions # oh-my-zsh
mv _flux ~/.zprezto/modules/completion/external/src/ # zprezto
```
### Options

View File

@@ -28,7 +28,6 @@ flux create alert-provider [name] [flags]
--type github \
--address https://github.com/stefanprodan/podinfo \
--secret-ref github-token
```
### Options

View File

@@ -22,7 +22,6 @@ flux create alert [name] [flags]
--event-source Kustomization/flux-system \
--provider-ref slack \
flux-system
```
### Options

View File

@@ -68,7 +68,6 @@ flux create helmrelease [name] [flags]
--chart=podinfo \
--values=./values.yaml \
--export > podinfo-release.yaml
```
### Options

View File

@@ -32,7 +32,6 @@ flux create image policy [name] [flags]
--select-numeric=asc \
--filter-regex='^main-[a-f0-9]+-(?P<ts>[0-9]+)' \
--filter-extract='$ts'
```
### Options

View File

@@ -41,7 +41,6 @@ flux create image repository [name] [flags]
flux create image repository app-repo \
--cert-secret-ref client-cert \
--image registry.example.com/private/app --interval 5m
```
### Options

View File

@@ -36,7 +36,6 @@ flux create image update [name] [flags]
--author-name=flux \
--author-email=flux@example.com \
--commit-template="{{range .Updated.Images}}{{println .}}{{end}}"
```
### Options

View File

@@ -41,7 +41,6 @@ flux create kustomization [name] [flags]
--source=Bucket/secrets \
--prune=true \
--interval=5m
```
### Options

View File

@@ -24,7 +24,6 @@ flux create receiver [name] [flags]
--secret-ref webhook-token \
--resource GitRepository/webapp \
--resource HelmRepository/webapp
```
### Options

View File

@@ -7,7 +7,6 @@ Create or update a Kubernetes secret for Helm repository authentication
### Synopsis
The create secret helm command generates a Kubernetes secret with basic authentication credentials.
```
@@ -17,8 +16,7 @@ flux create secret helm [name] [flags]
### Examples
```
# Create a Helm authentication secret on disk and encrypt it with Mozilla SOPS
# Create a Helm authentication secret on disk and encrypt it with Mozilla SOPS
flux create secret helm repo-auth \
--namespace=my-namespace \
--username=my-username \
@@ -28,14 +26,13 @@ flux create secret helm [name] [flags]
sops --encrypt --encrypted-regex '^(data|stringData)$' \
--in-place repo-auth.yaml
# Create an authentication secret using a custom TLS cert
# Create a Helm authentication secret using a custom TLS cert
flux create secret helm repo-auth \
--username=username \
--password=password \
--cert-file=./cert.crt \
--key-file=./key.crt \
--ca-file=./ca.crt
```
### Options

View File

@@ -7,7 +7,6 @@ Create or update a Kubernetes secret with TLS certificates
### Synopsis
The create secret tls command generates a Kubernetes secret with certificates for use with TLS.
```
@@ -17,8 +16,7 @@ flux create secret tls [name] [flags]
### Examples
```
# Create a TLS secret on disk and encrypt it with Mozilla SOPS.
# Create a TLS secret on disk and encrypt it with Mozilla SOPS.
# Files are expected to be PEM-encoded.
flux create secret tls certs \
--namespace=my-namespace \
@@ -28,7 +26,6 @@ flux create secret tls [name] [flags]
sops --encrypt --encrypted-regex '^(data|stringData)$' \
--in-place certs.yaml
```
### Options

View File

@@ -7,7 +7,6 @@ Create or update a Bucket source
### Synopsis
The create source bucket command generates a Bucket resource and waits for it to be downloaded.
For Buckets with static authentication, the credentials are stored in a Kubernetes secret.
@@ -18,7 +17,7 @@ flux create source bucket [name] [flags]
### Examples
```
# Create a source from a Buckets using static authentication
# Create a source for a Bucket using static authentication
flux create source bucket podinfo \
--bucket-name=podinfo \
--endpoint=minio.minio.svc.cluster.local:9000 \
@@ -27,14 +26,13 @@ flux create source bucket [name] [flags]
--secret-key=mysecretkey \
--interval=10m
# Create a source from an Amazon S3 Bucket using IAM authentication
# Create a source for an Amazon S3 Bucket using IAM authentication
flux create source bucket podinfo \
--bucket-name=podinfo \
--provider=aws \
--endpoint=s3.amazonaws.com \
--region=us-east-1 \
--interval=10m
```
### Options

View File

@@ -7,7 +7,6 @@ Create or update a HelmRepository source
### Synopsis
The create source helm command generates a HelmRepository resource and waits for it to fetch the index.
For private Helm repositories, the basic authentication credentials are stored in a Kubernetes secret.
@@ -18,24 +17,23 @@ flux create source helm [name] [flags]
### Examples
```
# Create a source from a public Helm repository
# Create a source for a public Helm repository
flux create source helm podinfo \
--url=https://stefanprodan.github.io/podinfo \
--interval=10m
# Create a source from a Helm repository using basic authentication
# Create a source for a Helm repository using basic authentication
flux create source helm podinfo \
--url=https://stefanprodan.github.io/podinfo \
--username=username \
--password=password
# Create a source from a Helm repository using TLS authentication
# Create a source for a Helm repository using TLS authentication
flux create source helm podinfo \
--url=https://stefanprodan.github.io/podinfo \
--cert-file=./cert.crt \
--key-file=./key.crt \
--ca-file=./ca.crt
```
### Options

View File

@@ -7,7 +7,6 @@ Create or update a tenant
### Synopsis
The create tenant command generates namespaces, service accounts and role bindings to limit the
reconcilers scope to the tenant namespaces.
@@ -28,7 +27,6 @@ flux create tenant [flags]
--with-namespace=frontend \
--with-namespace=backend \
--export > dev-team.yaml
```
### Options

View File

@@ -18,7 +18,6 @@ flux delete alert-provider [name] [flags]
```
# Delete a Provider and the Kubernetes resources created by it
flux delete alert-provider slack
```
### Options

View File

@@ -18,7 +18,6 @@ flux delete alert [name] [flags]
```
# Delete an Alert and the Kubernetes resources created by it
flux delete alert main
```
### Options

View File

@@ -18,7 +18,6 @@ flux delete helmrelease [name] [flags]
```
# Delete a Helm release and the Kubernetes resources created by it
flux delete hr podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux delete image policy [name] [flags]
```
# Delete an image policy
flux delete image policy alpine3.x
```
### Options

View File

@@ -18,7 +18,6 @@ flux delete image repository [name] [flags]
```
# Delete an image repository
flux delete image repository alpine
```
### Options

View File

@@ -18,7 +18,6 @@ flux delete image update [name] [flags]
```
# Delete an image update automation
flux delete image update latest-images
```
### Options

View File

@@ -18,7 +18,6 @@ flux delete kustomization [name] [flags]
```
# Delete a kustomization and the Kubernetes resources created by it
flux delete kustomization podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux delete receiver [name] [flags]
```
# Delete an Receiver and the Kubernetes resources created by it
flux delete receiver main
```
### Options

View File

@@ -18,7 +18,6 @@ flux delete source bucket [name] [flags]
```
# Delete a Bucket source
flux delete source bucket podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux delete source git [name] [flags]
```
# Delete a Git repository
flux delete source git podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux delete source helm [name] [flags]
```
# Delete a Helm repository
flux delete source helm podinfo
```
### Options

View File

@@ -21,7 +21,6 @@ flux export alert-provider [name] [flags]
# Export a Provider
flux export alert-provider slack > slack.yaml
```
### Options

View File

@@ -21,7 +21,6 @@ flux export alert [name] [flags]
# Export a Alert
flux export alert main > main.yaml
```
### Options

View File

@@ -21,7 +21,6 @@ flux export helmrelease [name] [flags]
# Export a HelmRelease
flux export hr my-app > app-release.yaml
```
### Options

View File

@@ -21,7 +21,6 @@ flux export image policy [name] [flags]
# Export a specific policy
flux export image policy alpine1x > alpine1x.yaml
```
### Options

View File

@@ -21,7 +21,6 @@ flux export image repository [name] [flags]
# Export a specific ImageRepository resource
flux export image repository alpine > alpine.yaml
```
### Options

View File

@@ -21,7 +21,6 @@ flux export image update [name] [flags]
# Export a specific automation
flux export image update latest-images > latest.yaml
```
### Options

View File

@@ -21,7 +21,6 @@ flux export kustomization [name] [flags]
# Export a Kustomization
flux export kustomization my-app > kustomization.yaml
```
### Options

View File

@@ -21,7 +21,6 @@ flux export receiver [name] [flags]
# Export a Receiver
flux export receiver main > main.yaml
```
### Options

View File

@@ -21,7 +21,6 @@ flux export source bucket [name] [flags]
# Export a Bucket source including the static credentials
flux export source bucket my-bucket --with-credentials > source.yaml
```
### Options

View File

@@ -21,7 +21,6 @@ flux export source git [name] [flags]
# Export a GitRepository source including the SSH key pair or basic auth credentials
flux export source git my-private-repo --with-credentials > source.yaml
```
### Options

View File

@@ -21,7 +21,6 @@ flux export source helm [name] [flags]
# Export a HelmRepository source including the basic auth credentials
flux export source helm my-private-repo --with-credentials > source.yaml
```
### Options

View File

@@ -18,7 +18,6 @@ flux get alert-providers [flags]
```
# List all Providers and their status
flux get alert-providers
```
### Options

View File

@@ -18,7 +18,6 @@ flux get alerts [flags]
```
# List all Alerts and their status
flux get alerts
```
### Options

View File

@@ -18,7 +18,6 @@ flux get helmreleases [flags]
```
# List all Helm releases and their status
flux get helmreleases
```
### Options

View File

@@ -21,7 +21,6 @@ flux get images all [flags]
# List all image objects in all namespaces
flux get images all --all-namespaces
```
### Options

View File

@@ -21,7 +21,6 @@ flux get images policy [flags]
# List image policies from all namespaces
flux get image policy --all-namespaces
```
### Options

View File

@@ -21,7 +21,6 @@ flux get images repository [flags]
# List image repositories from all namespaces
flux get image repository --all-namespaces
```
### Options

View File

@@ -21,7 +21,6 @@ flux get images update [flags]
# List image update automations from all namespaces
flux get image update --all-namespaces
```
### Options

View File

@@ -18,7 +18,6 @@ flux get kustomizations [flags]
```
# List all kustomizations and their status
flux get kustomizations
```
### Options

View File

@@ -18,7 +18,6 @@ flux get receivers [flags]
```
# List all Receiver and their status
flux get receivers
```
### Options

View File

@@ -21,7 +21,6 @@ flux get sources all [flags]
# List all sources in all namespaces
flux get sources all --all-namespaces
```
### Options

View File

@@ -21,7 +21,6 @@ flux get sources bucket [flags]
# List buckets from all namespaces
flux get sources helm --all-namespaces
```
### Options

View File

@@ -21,7 +21,6 @@ flux get sources chart [flags]
# List Helm charts from all namespaces
flux get sources chart --all-namespaces
```
### Options

View File

@@ -21,7 +21,6 @@ flux get sources git [flags]
# List Git repositories from all namespaces
flux get sources git --all-namespaces
```
### Options

View File

@@ -21,7 +21,6 @@ flux get sources helm [flags]
# List Helm repositories from all namespaces
flux get sources helm --all-namespaces
```
### Options

View File

@@ -31,7 +31,6 @@ flux install [flags]
# Write install manifests to file
flux install --export > flux-system.yaml
```
### Options

View File

@@ -18,7 +18,6 @@ flux reconcile alert-provider [name] [flags]
```
# Trigger a reconciliation for an existing provider
flux reconcile alert-provider slack
```
### Options

View File

@@ -18,7 +18,6 @@ flux reconcile alert [name] [flags]
```
# Trigger a reconciliation for an existing alert
flux reconcile alert main
```
### Options

View File

@@ -22,7 +22,6 @@ flux reconcile helmrelease [name] [flags]
# Trigger a reconciliation of the HelmRelease's source and apply changes
flux reconcile hr podinfo --with-source
```
### Options

View File

@@ -18,7 +18,6 @@ flux reconcile image repository [name] [flags]
```
# Trigger an scan for an existing image repository
flux reconcile image repository alpine
```
### Options

View File

@@ -18,7 +18,6 @@ flux reconcile image update [name] [flags]
```
# Trigger an automation run for an existing image update automation
flux reconcile image update latest-images
```
### Options

View File

@@ -22,7 +22,6 @@ flux reconcile kustomization [name] [flags]
# Trigger a sync of the Kustomization's source and apply changes
flux reconcile kustomization podinfo --with-source
```
### Options

View File

@@ -18,7 +18,6 @@ flux reconcile receiver [name] [flags]
```
# Trigger a reconciliation for an existing receiver
flux reconcile receiver main
```
### Options

View File

@@ -18,7 +18,6 @@ flux reconcile source bucket [name] [flags]
```
# Trigger a reconciliation for an existing source
flux reconcile source bucket podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux reconcile source git [name] [flags]
```
# Trigger a git pull for an existing source
flux reconcile source git podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux reconcile source helm [name] [flags]
```
# Trigger a reconciliation for an existing source
flux reconcile source helm podinfo
```
### Options

View File

@@ -19,7 +19,6 @@ flux resume alert [name] [flags]
```
# Resume reconciliation for an existing Alert
flux resume alert main
```
### Options

View File

@@ -19,7 +19,6 @@ flux resume helmrelease [name] [flags]
```
# Resume reconciliation for an existing Helm release
flux resume hr podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux resume image repository [name] [flags]
```
# Resume reconciliation for an existing ImageRepository
flux resume image repository alpine
```
### Options

View File

@@ -18,7 +18,6 @@ flux resume image update [name] [flags]
```
# Resume reconciliation for an existing ImageUpdateAutomation
flux resume image update latest-images
```
### Options

View File

@@ -19,7 +19,6 @@ flux resume kustomization [name] [flags]
```
# Resume reconciliation for an existing Kustomization
flux resume ks podinfo
```
### Options

View File

@@ -19,7 +19,6 @@ flux resume receiver [name] [flags]
```
# Resume reconciliation for an existing Receiver
flux resume receiver main
```
### Options

View File

@@ -18,7 +18,6 @@ flux resume source bucket [name] [flags]
```
# Resume reconciliation for an existing Bucket
flux resume source bucket podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux resume source chart [name] [flags]
```
# Resume reconciliation for an existing HelmChart
flux resume source chart podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux resume source git [name] [flags]
```
# Resume reconciliation for an existing GitRepository
flux resume source git podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux resume source helm [name] [flags]
```
# Resume reconciliation for an existing HelmRepository
flux resume source helm bitnami
```
### Options

View File

@@ -18,7 +18,6 @@ flux suspend alert [name] [flags]
```
# Suspend reconciliation for an existing Alert
flux suspend alert main
```
### Options

View File

@@ -18,7 +18,6 @@ flux suspend helmrelease [name] [flags]
```
# Suspend reconciliation for an existing Helm release
flux suspend hr podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux suspend image repository [name] [flags]
```
# Suspend reconciliation for an existing ImageRepository
flux suspend image repository alpine
```
### Options

View File

@@ -18,7 +18,6 @@ flux suspend image update [name] [flags]
```
# Suspend reconciliation for an existing ImageUpdateAutomation
flux suspend image update latest-images
```
### Options

View File

@@ -18,7 +18,6 @@ flux suspend kustomization [name] [flags]
```
# Suspend reconciliation for an existing Kustomization
flux suspend ks podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux suspend receiver [name] [flags]
```
# Suspend reconciliation for an existing Receiver
flux suspend receiver main
```
### Options

View File

@@ -18,7 +18,6 @@ flux suspend source bucket [name] [flags]
```
# Suspend reconciliation for an existing Bucket
flux suspend source bucket podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux suspend source chart [name] [flags]
```
# Suspend reconciliation for an existing HelmChart
flux suspend source chart podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux suspend source git [name] [flags]
```
# Suspend reconciliation for an existing GitRepository
flux suspend source git podinfo
```
### Options

View File

@@ -18,7 +18,6 @@ flux suspend source helm [name] [flags]
```
# Suspend reconciliation for an existing HelmRepository
flux suspend source helm bitnami
```
### Options

View File

@@ -21,7 +21,6 @@ flux uninstall [flags]
# Uninstall Flux but keep the namespace
flux uninstall --namespace=infra --keep-namespace=true
```
### Options