Mirrors
/
flux2
mirror of https://github.com/fluxcd/flux2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tidy up command descriptions

Browse Source 
Rewordings and removal of superfluous newlines.

Signed-off-by: Hidde Beydals <hello@hidde.co>
pull/1162/head
Hidde Beydals 4 years ago
parent 1b2ffad2f1
commit 236ffd1767
179 changed files with 161 additions and 354 deletions
Show Stats Download Patch File Download Diff File

29
cmd/flux/bootstrap_github.go
Unescape Escape View File

@ -47,27 +47,26 @@ the bootstrap command will perform an upgrade if needed.`,
Example: ` # 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 private repository hosted on GitHub Enterprise using HTTPS auth
flux bootstrap github --owner=<organization> --repository=<repository 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 an existing repository with a branch named main
flux bootstrap github --owner=<organization> --repository=<repository name> --branch=main`,
RunE: bootstrapGitHubCmdRun,
}
@ -220,7 +219,7 @@ func bootstrapGitHubCmdRun(cmd *cobra.Command, args []string) error {
logger.Successf("components are up to date")
}
// determine if repo synchronization is working
// determine if repository synchronization is working
isInstall := shouldInstallManifests(ctx, kubeClient, rootArgs.namespace)
if isInstall {
@ -281,7 +280,7 @@ func bootstrapGitHubCmdRun(cmd *cobra.Command, args []string) error {
}
}
// configure repo synchronization
// configure repository synchronization
logger.Actionf("generating sync manifests")
syncManifests, err := generateSyncManifests(
repoURL,

23
cmd/flux/bootstrap_gitlab.go
Unescape Escape View File

@ -49,24 +49,23 @@ the bootstrap command will perform an upgrade if needed.`,
Example: ` # 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`,
RunE: bootstrapGitLabCmdRun,
}
@ -207,7 +206,7 @@ func bootstrapGitLabCmdRun(cmd *cobra.Command, args []string) error {
logger.Successf("components are up to date")
}
// determine if repo synchronization is working
// determine if repository synchronization is working
isInstall := shouldInstallManifests(ctx, kubeClient, rootArgs.namespace)
if isInstall {
@ -268,7 +267,7 @@ func bootstrapGitLabCmdRun(cmd *cobra.Command, args []string) error {
}
}
// configure repo synchronization
// configure repository synchronization
logger.Actionf("generating sync manifests")
syncManifests, err := generateSyncManifests(
repoURL,

3
cmd/flux/check.go
Unescape Escape View File

@ -46,8 +46,7 @@ the local environment is configured correctly and if the installed components ar
flux check --pre
# Run installation checks
flux check
`,
flux check`,
RunE: runCheckCmd,
}

3
cmd/flux/completion_bash.go
Unescape Escape View File

@ -32,8 +32,7 @@ var completionBashCmd = &cobra.Command{
To configure your bash shell to load completions for each session add to your bashrc
# ~/.bashrc or ~/.profile
command -v flux >/dev/null && . <(flux completion bash)
`,
command -v flux >/dev/null && . <(flux completion bash)`,
Run: func(cmd *cobra.Command, args []string) {
rootCmd.GenBashCompletion(os.Stdout)
},

3
cmd/flux/completion_fish.go
Unescape Escape View File

@ -29,8 +29,7 @@ var completionFishCmd = &cobra.Command{
flux completion fish > ~/.config/fish/completions/flux.fish
See http://fishshell.com/docs/current/index.html#completion-own for more details
`,
See http://fishshell.com/docs/current/index.html#completion-own for more details`,
Run: func(cmd *cobra.Command, args []string) {
rootCmd.GenFishCompletion(os.Stdout, true)
},

3
cmd/flux/completion_powershell.go
Unescape Escape View File

@ -39,8 +39,7 @@ flux completion >> flux-completion.ps1
Linux:
cd "${XDG_CONFIG_HOME:-"$HOME/.config/"}/powershell/modules"
flux completion >> flux-completions.ps1
`,
flux completion >> flux-completions.ps1`,
Run: func(cmd *cobra.Command, args []string) {
rootCmd.GenPowerShellCompletion(os.Stdout)
},

3
cmd/flux/completion_zsh.go
Unescape Escape View File

@ -40,8 +40,7 @@ echo "${fpath// /\n}" | grep -i completion
flux completion zsh > _flux
mv _flux ~/.oh-my-zsh/completions # oh-my-zsh
mv _flux ~/.zprezto/modules/completion/external/src/ # zprezto
`,
mv _flux ~/.zprezto/modules/completion/external/src/ # zprezto`,
Run: func(cmd *cobra.Command, args []string) {
rootCmd.GenZshCompletion(os.Stdout)
},

3
cmd/flux/create_alert.go
Unescape Escape View File

@ -43,8 +43,7 @@ var createAlertCmd = &cobra.Command{
--event-severity info \
--event-source Kustomization/flux-system \
--provider-ref slack \
flux-system
`,
flux-system`,
RunE: createAlertCmdRun,
}

3
cmd/flux/create_alertprovider.go
Unescape Escape View File

@ -49,8 +49,7 @@ var createAlertProviderCmd = &cobra.Command{
flux create alert-provider github-podinfo \
--type github \
--address https://github.com/stefanprodan/podinfo \
--secret-ref github-token
`,
--secret-ref github-token`,
RunE: createAlertProviderCmdRun,
}

3
cmd/flux/create_helmrelease.go
Unescape Escape View File

@ -96,8 +96,7 @@ var createHelmReleaseCmd = &cobra.Command{
--source=HelmRepository/podinfo \
--chart=podinfo \
--values=./values.yaml \
--export > podinfo-release.yaml
`,
--export > podinfo-release.yaml`,
RunE: createHelmReleaseCmdRun,
}

7
cmd/flux/create_image.go
Unescape Escape View File

@ -17,20 +17,17 @@ limitations under the License.
package main
import (
"strings"
"github.com/spf13/cobra"
)
const createImageLong = `
The create image sub-commands work with image automation objects; that is,
const createImageLong = `The create image sub-commands work with image automation objects; that is,
object controlling updates to git based on e.g., new container images
being available.`
var createImageCmd = &cobra.Command{
Use: "image",
Short: "Create or update resources dealing with image automation",
Long: strings.TrimSpace(createImageLong),
Long: createImageLong,
}
func init() {

3
cmd/flux/create_image_policy.go
Unescape Escape View File

@ -50,8 +50,7 @@ the status of the object.`,
--image-ref=podinfo \
--select-numeric=asc \
--filter-regex='^main-[a-f0-9]+-(?P<ts>[0-9]+)' \
--filter-extract='$ts'
`,
--filter-extract='$ts'`,
RunE: createImagePolicyRun}
type imagePolicyFlags struct {

3
cmd/flux/create_image_repository.go
Unescape Escape View File

@ -57,8 +57,7 @@ An ImageRepository object specifies an image repository to scan.`,
--cert-file client.crt --key-file client.key
flux create image repository app-repo \
--cert-secret-ref client-cert \
--image registry.example.com/private/app --interval 5m
`,
--image registry.example.com/private/app --interval 5m`,
RunE: createImageRepositoryRun,
}

3
cmd/flux/create_image_update.go
Unescape Escape View File

@ -50,8 +50,7 @@ mentioned in YAMLs in a git repository.`,
--push-branch=image-updates \
--author-name=flux \
--author-email=flux@example.com \
--commit-template="{{range .Updated.Images}}{{println .}}{{end}}"
`,
--commit-template="{{range .Updated.Images}}{{println .}}{{end}}"`,
RunE: createImageUpdateRun,
}

3
cmd/flux/create_kustomization.go
Unescape Escape View File

@ -68,8 +68,7 @@ var createKsCmd = &cobra.Command{
flux create kustomization secrets \
--source=Bucket/secrets \
--prune=true \
--interval=5m
`,
--interval=5m`,
RunE: createKsCmdRun,
}

3
cmd/flux/create_receiver.go
Unescape Escape View File

@ -45,8 +45,7 @@ var createReceiverCmd = &cobra.Command{
--event push \
--secret-ref webhook-token \
--resource GitRepository/webapp \
--resource HelmRepository/webapp
`,
--resource HelmRepository/webapp`,
RunE: createReceiverCmdRun,
}

11
cmd/flux/create_secret_helm.go
Unescape Escape View File

@ -31,10 +31,8 @@ import (
var createSecretHelmCmd = &cobra.Command{
Use: "helm [name]",
Short: "Create or update a Kubernetes secret for Helm repository authentication",
Long: `
The create secret helm command generates a Kubernetes secret with basic authentication credentials.`,
Example: `
# Create a Helm authentication secret on disk and encrypt it with Mozilla SOPS
Long: `The create secret helm command generates a Kubernetes secret with basic authentication credentials.`,
Example: ` # 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 \
@ -44,14 +42,13 @@ The create secret helm command generates a Kubernetes secret with basic authenti
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
`,
--ca-file=./ca.crt`,
RunE: createSecretHelmCmdRun,
}

9
cmd/flux/create_secret_tls.go
Unescape Escape View File

@ -32,10 +32,8 @@ import (
var createSecretTLSCmd = &cobra.Command{
Use: "tls [name]",
Short: "Create or update a Kubernetes secret with TLS certificates",
Long: `
The create secret tls command generates a Kubernetes secret with certificates for use with TLS.`,
Example: `
# Create a TLS secret on disk and encrypt it with Mozilla SOPS.
Long: `The create secret tls command generates a Kubernetes secret with certificates for use with TLS.`,
Example: ` # 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 \
@ -44,8 +42,7 @@ The create secret tls command generates a Kubernetes secret with certificates fo
--export > certs.yaml
sops --encrypt --encrypted-regex '^(data|stringData)$' \
--in-place certs.yaml
`,
--in-place certs.yaml`,
RunE: createSecretTLSCmdRun,
}

10
cmd/flux/create_source_bucket.go
Unescape Escape View File

@ -40,10 +40,9 @@ import (
var createSourceBucketCmd = &cobra.Command{
Use: "bucket [name]",
Short: "Create or update a Bucket source",
Long: `
The create source bucket command generates a Bucket resource and waits for it to be downloaded.
Long: `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.`,
Example: ` # Create a source from a Buckets using static authentication
Example: ` # Create a source for a Bucket using static authentication
flux create source bucket podinfo \
--bucket-name=podinfo \
--endpoint=minio.minio.svc.cluster.local:9000 \
@ -52,14 +51,13 @@ For Buckets with static authentication, the credentials are stored in a Kubernet
--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
`,
--interval=10m`,
RunE: createSourceBucketCmdRun,
}

12
cmd/flux/create_source_helm.go
Unescape Escape View File

@ -43,27 +43,25 @@ import (
var createSourceHelmCmd = &cobra.Command{
Use: "helm [name]",
Short: "Create or update a HelmRepository source",
Long: `
The create source helm command generates a HelmRepository resource and waits for it to fetch the index.
Long: `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.`,
Example: ` # Create a source from a public Helm repository
Example: ` # 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
`,
--ca-file=./ca.crt`,
RunE: createSourceHelmCmdRun,
}

6
cmd/flux/create_tenant.go
Unescape Escape View File

@ -37,8 +37,7 @@ import (
var createTenantCmd = &cobra.Command{
Use: "tenant",
Short: "Create or update a tenant",
Long: `
The create tenant command generates namespaces, service accounts and role bindings to limit the
Long: `The create tenant command generates namespaces, service accounts and role bindings to limit the
reconcilers scope to the tenant namespaces.`,
Example: ` # Create a tenant with access to a namespace
flux create tenant dev-team \
@ -49,8 +48,7 @@ reconcilers scope to the tenant namespaces.`,
flux create tenant dev-team \
--with-namespace=frontend \
--with-namespace=backend \
--export > dev-team.yaml
`,
--export > dev-team.yaml`,
RunE: createTenantCmdRun,
}

3
cmd/flux/delete_alert.go
Unescape Escape View File

@ -26,8 +26,7 @@ var deleteAlertCmd = &cobra.Command{
Short: "Delete a Alert resource",
Long: "The delete alert command removes the given Alert from the cluster.",
Example: ` # Delete an Alert and the Kubernetes resources created by it
flux delete alert main
`,
flux delete alert main`,
RunE: deleteCommand{
apiType: alertType,
object: universalAdapter{&notificationv1.Alert{}},

3
cmd/flux/delete_alertprovider.go
Unescape Escape View File

@ -26,8 +26,7 @@ var deleteAlertProviderCmd = &cobra.Command{
Short: "Delete a Provider resource",
Long: "The delete alert-provider command removes the given Provider from the cluster.",
Example: ` # Delete a Provider and the Kubernetes resources created by it
flux delete alert-provider slack
`,
flux delete alert-provider slack`,
RunE: deleteCommand{
apiType: alertProviderType,
object: universalAdapter{&notificationv1.Provider{}},

3
cmd/flux/delete_helmrelease.go
Unescape Escape View File

@ -27,8 +27,7 @@ var deleteHelmReleaseCmd = &cobra.Command{
Short: "Delete a HelmRelease resource",
Long: "The delete helmrelease command removes the given HelmRelease from the cluster.",
Example: ` # Delete a Helm release and the Kubernetes resources created by it
flux delete hr podinfo
`,
flux delete hr podinfo`,
RunE: deleteCommand{
apiType: helmReleaseType,
object: universalAdapter{&helmv2.HelmRelease{}},

3
cmd/flux/delete_image_policy.go
Unescape Escape View File

@ -27,8 +27,7 @@ var deleteImagePolicyCmd = &cobra.Command{
Short: "Delete an ImagePolicy object",
Long: "The delete image policy command deletes the given ImagePolicy from the cluster.",
Example: ` # Delete an image policy
flux delete image policy alpine3.x
`,
flux delete image policy alpine3.x`,
RunE: deleteCommand{
apiType: imagePolicyType,
object: universalAdapter{&imagev1.ImagePolicy{}},

3
cmd/flux/delete_image_repository.go
Unescape Escape View File

@ -27,8 +27,7 @@ var deleteImageRepositoryCmd = &cobra.Command{
Short: "Delete an ImageRepository object",
Long: "The delete image repository command deletes the given ImageRepository from the cluster.",
Example: ` # Delete an image repository
flux delete image repository alpine
`,
flux delete image repository alpine`,
RunE: deleteCommand{
apiType: imageRepositoryType,
object: universalAdapter{&imagev1.ImageRepository{}},

3
cmd/flux/delete_image_update.go
Unescape Escape View File

@ -27,8 +27,7 @@ var deleteImageUpdateCmd = &cobra.Command{
Short: "Delete an ImageUpdateAutomation object",
Long: "The delete image update command deletes the given ImageUpdateAutomation from the cluster.",
Example: ` # Delete an image update automation
flux delete image update latest-images
`,
flux delete image update latest-images`,
RunE: deleteCommand{
apiType: imageUpdateAutomationType,
object: universalAdapter{&autov1.ImageUpdateAutomation{}},

3
cmd/flux/delete_kustomization.go
Unescape Escape View File

@ -27,8 +27,7 @@ var deleteKsCmd = &cobra.Command{
Short: "Delete a Kustomization resource",
Long: "The delete kustomization command deletes the given Kustomization from the cluster.",
Example: ` # Delete a kustomization and the Kubernetes resources created by it
flux delete kustomization podinfo
`,
flux delete kustomization podinfo`,
RunE: deleteCommand{
apiType: kustomizationType,
object: universalAdapter{&kustomizev1.Kustomization{}},

3
cmd/flux/delete_receiver.go
Unescape Escape View File

@ -26,8 +26,7 @@ var deleteReceiverCmd = &cobra.Command{
Short: "Delete a Receiver resource",
Long: "The delete receiver command removes the given Receiver from the cluster.",
Example: ` # Delete an Receiver and the Kubernetes resources created by it
flux delete receiver main
`,
flux delete receiver main`,
RunE: deleteCommand{
apiType: receiverType,
object: universalAdapter{&notificationv1.Receiver{}},

3
cmd/flux/delete_source_bucket.go
Unescape Escape View File

@ -26,8 +26,7 @@ var deleteSourceBucketCmd = &cobra.Command{
Short: "Delete a Bucket source",
Long: "The delete source bucket command deletes the given Bucket from the cluster.",
Example: ` # Delete a Bucket source
flux delete source bucket podinfo
`,
flux delete source bucket podinfo`,
RunE: deleteCommand{
apiType: bucketType,
object: universalAdapter{&sourcev1.Bucket{}},

3
cmd/flux/delete_source_git.go
Unescape Escape View File

@ -26,8 +26,7 @@ var deleteSourceGitCmd = &cobra.Command{
Short: "Delete a GitRepository source",
Long: "The delete source git command deletes the given GitRepository from the cluster.",
Example: ` # Delete a Git repository
flux delete source git podinfo
`,
flux delete source git podinfo`,
RunE: deleteCommand{
apiType: gitRepositoryType,
object: universalAdapter{&sourcev1.GitRepository{}},

3
cmd/flux/delete_source_helm.go
Unescape Escape View File

@ -26,8 +26,7 @@ var deleteSourceHelmCmd = &cobra.Command{
Short: "Delete a HelmRepository source",
Long: "The delete source helm command deletes the given HelmRepository from the cluster.",
Example: ` # Delete a Helm repository
flux delete source helm podinfo
`,
flux delete source helm podinfo`,
RunE: deleteCommand{
apiType: helmRepositoryType,
object: universalAdapter{&sourcev1.HelmRepository{}},

3
cmd/flux/export_alert.go
Unescape Escape View File

@ -30,8 +30,7 @@ var exportAlertCmd = &cobra.Command{
flux export alert --all > alerts.yaml
# Export a Alert
flux export alert main > main.yaml
`,
flux export alert main > main.yaml`,
RunE: exportCommand{
object: alertAdapter{&notificationv1.Alert{}},
list: alertListAdapter{&notificationv1.AlertList{}},

3
cmd/flux/export_alertprovider.go
Unescape Escape View File

@ -30,8 +30,7 @@ var exportAlertProviderCmd = &cobra.Command{
flux export alert-provider --all > alert-providers.yaml
# Export a Provider
flux export alert-provider slack > slack.yaml
`,
flux export alert-provider slack > slack.yaml`,
RunE: exportCommand{
object: alertProviderAdapter{&notificationv1.Provider{}},
list: alertProviderListAdapter{&notificationv1.ProviderList{}},

3
cmd/flux/export_helmrelease.go
Unescape Escape View File

@ -31,8 +31,7 @@ var exportHelmReleaseCmd = &cobra.Command{
flux export helmrelease --all > kustomizations.yaml
# Export a HelmRelease
flux export hr my-app > app-release.yaml
`,
flux export hr my-app > app-release.yaml`,
RunE: exportCommand{
object: helmReleaseAdapter{&helmv2.HelmRelease{}},
list: helmReleaseListAdapter{&helmv2.HelmReleaseList{}},

3
cmd/flux/export_image_policy.go
Unescape Escape View File

@ -31,8 +31,7 @@ var exportImagePolicyCmd = &cobra.Command{
flux export image policy --all > image-policies.yaml
# Export a specific policy
flux export image policy alpine1x > alpine1x.yaml
`,
flux export image policy alpine1x > alpine1x.yaml`,
RunE: exportCommand{
object: imagePolicyAdapter{&imagev1.ImagePolicy{}},
list: imagePolicyListAdapter{&imagev1.ImagePolicyList{}},

3
cmd/flux/export_image_repository.go
Unescape Escape View File

@ -31,8 +31,7 @@ var exportImageRepositoryCmd = &cobra.Command{
flux export image repository --all > image-repositories.yaml
# Export a specific ImageRepository resource
flux export image repository alpine > alpine.yaml
`,
flux export image repository alpine > alpine.yaml`,
RunE: exportCommand{
object: imageRepositoryAdapter{&imagev1.ImageRepository{}},
list: imageRepositoryListAdapter{&imagev1.ImageRepositoryList{}},

3
cmd/flux/export_image_update.go
Unescape Escape View File

@ -31,8 +31,7 @@ var exportImageUpdateCmd = &cobra.Command{
flux export image update --all > updates.yaml
# Export a specific automation
flux export image update latest-images > latest.yaml
`,
flux export image update latest-images > latest.yaml`,
RunE: exportCommand{
object: imageUpdateAutomationAdapter{&autov1.ImageUpdateAutomation{}},
list: imageUpdateAutomationListAdapter{&autov1.ImageUpdateAutomationList{}},

3
cmd/flux/export_kustomization.go
Unescape Escape View File

@ -31,8 +31,7 @@ var exportKsCmd = &cobra.Command{
flux export kustomization --all > kustomizations.yaml
# Export a Kustomization
flux export kustomization my-app > kustomization.yaml
`,
flux export kustomization my-app > kustomization.yaml`,
RunE: exportCommand{
object: kustomizationAdapter{&kustomizev1.Kustomization{}},
list: kustomizationListAdapter{&kustomizev1.KustomizationList{}},

3
cmd/flux/export_receiver.go
Unescape Escape View File

@ -30,8 +30,7 @@ var exportReceiverCmd = &cobra.Command{
flux export receiver --all > receivers.yaml
# Export a Receiver
flux export receiver main > main.yaml
`,
flux export receiver main > main.yaml`,
RunE: exportCommand{
list: receiverListAdapter{&notificationv1.ReceiverList{}},
object: receiverAdapter{&notificationv1.Receiver{}},

3
cmd/flux/export_source_bucket.go
Unescape Escape View File

@ -31,8 +31,7 @@ var exportSourceBucketCmd = &cobra.Command{
flux export source bucket --all > sources.yaml
# Export a Bucket source including the static credentials
flux export source bucket my-bucket --with-credentials > source.yaml
`,
flux export source bucket my-bucket --with-credentials > source.yaml`,
RunE: exportWithSecretCommand{
list: bucketListAdapter{&sourcev1.BucketList{}},
object: bucketAdapter{&sourcev1.Bucket{}},

3
cmd/flux/export_source_git.go
Unescape Escape View File

@ -31,8 +31,7 @@ var exportSourceGitCmd = &cobra.Command{
flux export source git --all > sources.yaml
# Export a GitRepository source including the SSH key pair or basic auth credentials
flux export source git my-private-repo --with-credentials > source.yaml
`,
flux export source git my-private-repo --with-credentials > source.yaml`,
RunE: exportWithSecretCommand{
object: gitRepositoryAdapter{&sourcev1.GitRepository{}},
list: gitRepositoryListAdapter{&sourcev1.GitRepositoryList{}},

3
cmd/flux/export_source_helm.go
Unescape Escape View File

@ -31,8 +31,7 @@ var exportSourceHelmCmd = &cobra.Command{
flux export source helm --all > sources.yaml
# Export a HelmRepository source including the basic auth credentials
flux export source helm my-private-repo --with-credentials > source.yaml
`,
flux export source helm my-private-repo --with-credentials > source.yaml`,
RunE: exportWithSecretCommand{
list: helmRepositoryListAdapter{&sourcev1.HelmRepositoryList{}},
object: helmRepositoryAdapter{&sourcev1.HelmRepository{}},

3
cmd/flux/get_alert.go
Unescape Escape View File

@ -30,8 +30,7 @@ var getAlertCmd = &cobra.Command{
Short: "Get Alert statuses",
Long: "The get alert command prints the statuses of the resources.",
Example: ` # List all Alerts and their status
flux get alerts
`,
flux get alerts`,
RunE: getCommand{
apiType: alertType,
list: &alertListAdapter{&notificationv1.AlertList{}},

3
cmd/flux/get_alertprovider.go
Unescape Escape View File

@ -27,8 +27,7 @@ var getAlertProviderCmd = &cobra.Command{
Short: "Get Provider statuses",
Long: "The get alert-provider command prints the statuses of the resources.",
Example: ` # List all Providers and their status
flux get alert-providers
`,
flux get alert-providers`,
RunE: getCommand{
apiType: alertProviderType,
list: alertProviderListAdapter{&notificationv1.ProviderList{}},

3
cmd/flux/get_helmrelease.go
Unescape Escape View File

@ -30,8 +30,7 @@ var getHelmReleaseCmd = &cobra.Command{
Short: "Get HelmRelease statuses",
Long: "The get helmreleases command prints the statuses of the resources.",
Example: ` # List all Helm releases and their status
flux get helmreleases
`,
flux get helmreleases`,
RunE: getCommand{
apiType: helmReleaseType,
list: &helmReleaseListAdapter{&helmv2.HelmReleaseList{}},

3
cmd/flux/get_image_all.go
Unescape Escape View File

@ -30,8 +30,7 @@ var getImageAllCmd = &cobra.Command{
flux get images all --namespace=flux-system
# List all image objects in all namespaces
flux get images all --all-namespaces
`,
flux get images all --all-namespaces`,
RunE: func(cmd *cobra.Command, args []string) error {
c := getCommand{
apiType: imageRepositoryType,

3
cmd/flux/get_image_policy.go
Unescape Escape View File

@ -30,8 +30,7 @@ var getImagePolicyCmd = &cobra.Command{
flux get image policy
# List image policies from all namespaces
flux get image policy --all-namespaces
`,
flux get image policy --all-namespaces`,
RunE: getCommand{
apiType: imagePolicyType,
list: &imagePolicyListAdapter{&imagev1.ImagePolicyList{}},

3
cmd/flux/get_image_repository.go
Unescape Escape View File

@ -34,8 +34,7 @@ var getImageRepositoryCmd = &cobra.Command{
flux get image repository
# List image repositories from all namespaces
flux get image repository --all-namespaces
`,
flux get image repository --all-namespaces`,
RunE: getCommand{
apiType: imageRepositoryType,
list: imageRepositoryListAdapter{&imagev1.ImageRepositoryList{}},

3
cmd/flux/get_image_update.go
Unescape Escape View File

@ -34,8 +34,7 @@ var getImageUpdateCmd = &cobra.Command{
flux get image update
# List image update automations from all namespaces
flux get image update --all-namespaces
`,
flux get image update --all-namespaces`,
RunE: getCommand{
apiType: imageUpdateAutomationType,
list: &imageUpdateAutomationListAdapter{&autov1.ImageUpdateAutomationList{}},

3
cmd/flux/get_kustomization.go
Unescape Escape View File

@ -30,8 +30,7 @@ var getKsCmd = &cobra.Command{
Short: "Get Kustomization statuses",
Long: "The get kustomizations command prints the statuses of the resources.",
Example: ` # List all kustomizations and their status
flux get kustomizations
`,
flux get kustomizations`,
RunE: getCommand{
apiType: kustomizationType,
list: &kustomizationListAdapter{&kustomizev1.KustomizationList{}},

3
cmd/flux/get_receiver.go
Unescape Escape View File

@ -30,8 +30,7 @@ var getReceiverCmd = &cobra.Command{
Short: "Get Receiver statuses",
Long: "The get receiver command prints the statuses of the resources.",
Example: ` # List all Receiver and their status
flux get receivers
`,
flux get receivers`,
RunE: getCommand{
apiType: receiverType,
list: receiverListAdapter{&notificationv1.ReceiverList{}},

3
cmd/flux/get_source_all.go
Unescape Escape View File

@ -29,8 +29,7 @@ var getSourceAllCmd = &cobra.Command{
flux get sources all --namespace=flux-system
# List all sources in all namespaces
flux get sources all --all-namespaces
`,
flux get sources all --all-namespaces`,
RunE: func(cmd *cobra.Command, args []string) error {
c := getCommand{
apiType: bucketType,

3
cmd/flux/get_source_bucket.go
Unescape Escape View File

@ -32,8 +32,7 @@ var getSourceBucketCmd = &cobra.Command{
flux get sources bucket
# List buckets from all namespaces
flux get sources helm --all-namespaces
`,
flux get sources helm --all-namespaces`,
RunE: getCommand{
apiType: bucketType,
list: &bucketListAdapter{&sourcev1.BucketList{}},

3
cmd/flux/get_source_chart.go
Unescape Escape View File

@ -32,8 +32,7 @@ var getSourceHelmChartCmd = &cobra.Command{
flux get sources chart
# List Helm charts from all namespaces
flux get sources chart --all-namespaces
`,
flux get sources chart --all-namespaces`,
RunE: getCommand{
apiType: helmChartType,
list: &helmChartListAdapter{&sourcev1.HelmChartList{}},

3
cmd/flux/get_source_git.go
Unescape Escape View File

@ -32,8 +32,7 @@ var getSourceGitCmd = &cobra.Command{
flux get sources git
# List Git repositories from all namespaces
flux get sources git --all-namespaces
`,
flux get sources git --all-namespaces`,
RunE: getCommand{
apiType: gitRepositoryType,
list: &gitRepositoryListAdapter{&sourcev1.GitRepositoryList{}},

3
cmd/flux/get_source_helm.go
Unescape Escape View File

@ -32,8 +32,7 @@ var getSourceHelmCmd = &cobra.Command{
flux get sources helm
# List Helm repositories from all namespaces
flux get sources helm --all-namespaces
`,
flux get sources helm --all-namespaces`,
RunE: getCommand{
apiType: helmRepositoryType,
list: &helmRepositoryListAdapter{&sourcev1.HelmRepositoryList{}},

3
cmd/flux/install.go
Unescape Escape View File

@ -51,8 +51,7 @@ If a previous version is installed, then an in-place upgrade will be performed.`
flux install --dry-run --verbose
# Write install manifests to file
flux install --export > flux-system.yaml
`,
flux install --export > flux-system.yaml`,
RunE: installCmdRun,
}

8
cmd/flux/main.go
Unescape Escape View File

@ -36,14 +36,15 @@ var rootCmd = &cobra.Command{
SilenceUsage: true,
SilenceErrors: true,
Short: "Command line utility for assembling Kubernetes CD pipelines",
Long: `Command line utility for assembling Kubernetes CD pipelines the GitOps way.`,
Long: `
Command line utility for assembling Kubernetes CD pipelines the GitOps way.`,
Example: ` # Check prerequisites
flux check --pre
# 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 \
@ -88,8 +89,7 @@ var rootCmd = &cobra.Command{
flux delete source git webapp-latest
# Uninstall Flux and delete CRDs
flux uninstall
`,
flux uninstall`,
}
var logger = stderrLogger{stderr: os.Stderr}

3
cmd/flux/reconcile_alert.go
Unescape Escape View File

@ -36,8 +36,7 @@ var reconcileAlertCmd = &cobra.Command{
Short: "Reconcile an Alert",
Long: `The reconcile alert command triggers a reconciliation of an Alert resource and waits for it to finish.`,
Example: ` # Trigger a reconciliation for an existing alert
flux reconcile alert main
`,
flux reconcile alert main`,
RunE: reconcileAlertCmdRun,
}

3
cmd/flux/reconcile_alertprovider.go
Unescape Escape View File

@ -36,8 +36,7 @@ var reconcileAlertProviderCmd = &cobra.Command{
Short: "Reconcile a Provider",
Long: `The reconcile alert-provider command triggers a reconciliation of a Provider resource and waits for it to finish.`,
Example: ` # Trigger a reconciliation for an existing provider
flux reconcile alert-provider slack
`,
flux reconcile alert-provider slack`,
RunE: reconcileAlertProviderCmdRun,
}

3
cmd/flux/reconcile_helmrelease.go
Unescape Escape View File

@ -46,8 +46,7 @@ The reconcile kustomization command triggers a reconciliation of a HelmRelease r
flux reconcile hr podinfo
# Trigger a reconciliation of the HelmRelease's source and apply changes
flux reconcile hr podinfo --with-source
`,
flux reconcile hr podinfo --with-source`,
RunE: reconcileHrCmdRun,
}

3
cmd/flux/reconcile_image_repository.go
Unescape Escape View File

@ -29,8 +29,7 @@ var reconcileImageRepositoryCmd = &cobra.Command{
Short: "Reconcile an ImageRepository",
Long: `The reconcile image repository command triggers a reconciliation of an ImageRepository resource and waits for it to finish.`,
Example: ` # Trigger an scan for an existing image repository
flux reconcile image repository alpine
`,
flux reconcile image repository alpine`,
RunE: reconcileCommand{
apiType: imageRepositoryType,
object: imageRepositoryAdapter{&imagev1.ImageRepository{}},

3
cmd/flux/reconcile_image_updateauto.go
Unescape Escape View File

@ -31,8 +31,7 @@ var reconcileImageUpdateCmd = &cobra.Command{
Short: "Reconcile an ImageUpdateAutomation",
Long: `The reconcile image update command triggers a reconciliation of an ImageUpdateAutomation resource and waits for it to finish.`,
Example: ` # Trigger an automation run for an existing image update automation
flux reconcile image update latest-images
`,
flux reconcile image update latest-images`,
RunE: reconcileCommand{
apiType: imageUpdateAutomationType,
object: imageUpdateAutomationAdapter{&autov1.ImageUpdateAutomation{}},

3
cmd/flux/reconcile_kustomization.go
Unescape Escape View File

@ -45,8 +45,7 @@ The reconcile kustomization command triggers a reconciliation of a Kustomization
flux reconcile kustomization podinfo
# Trigger a sync of the Kustomization's source and apply changes
flux reconcile kustomization podinfo --with-source
`,
flux reconcile kustomization podinfo --with-source`,
RunE: reconcileKsCmdRun,
}

3
cmd/flux/reconcile_receiver.go
Unescape Escape View File

@ -36,8 +36,7 @@ var reconcileReceiverCmd = &cobra.Command{
Short: "Reconcile a Receiver",
Long: `The reconcile receiver command triggers a reconciliation of a Receiver resource and waits for it to finish.`,
Example: ` # Trigger a reconciliation for an existing receiver
flux reconcile receiver main
`,
flux reconcile receiver main`,
RunE: reconcileReceiverCmdRun,
}

3
cmd/flux/reconcile_source_bucket.go
Unescape Escape View File

@ -35,8 +35,7 @@ var reconcileSourceBucketCmd = &cobra.Command{
Short: "Reconcile a Bucket source",
Long: `The reconcile source command triggers a reconciliation of a Bucket resource and waits for it to finish.`,
Example: ` # Trigger a reconciliation for an existing source
flux reconcile source bucket podinfo
`,
flux reconcile source bucket podinfo`,
RunE: reconcileCommand{
apiType: bucketType,
object: bucketAdapter{&sourcev1.Bucket{}},

3
cmd/flux/reconcile_source_git.go
Unescape Escape View File

@ -27,8 +27,7 @@ var reconcileSourceGitCmd = &cobra.Command{
Short: "Reconcile a GitRepository source",
Long: `The reconcile source command triggers a reconciliation of a GitRepository resource and waits for it to finish.`,
Example: ` # Trigger a git pull for an existing source
flux reconcile source git podinfo
`,
flux reconcile source git podinfo`,
RunE: reconcileCommand{
apiType: gitRepositoryType,
object: gitRepositoryAdapter{&sourcev1.GitRepository{}},

3
cmd/flux/reconcile_source_helm.go
Unescape Escape View File

@ -27,8 +27,7 @@ var reconcileSourceHelmCmd = &cobra.Command{
Short: "Reconcile a HelmRepository source",
Long: `The reconcile source command triggers a reconciliation of a HelmRepository resource and waits for it to finish.`,
Example: ` # Trigger a reconciliation for an existing source
flux reconcile source helm podinfo
`,
flux reconcile source helm podinfo`,
RunE: reconcileCommand{
apiType: helmRepositoryType,
object: helmRepositoryAdapter{&sourcev1.HelmRepository{}},

3
cmd/flux/resume_alert.go
Unescape Escape View File

@ -39,8 +39,7 @@ var resumeAlertCmd = &cobra.Command{
Long: `The resume command marks a previously suspended Alert resource for reconciliation and waits for it to
finish the apply.`,
Example: ` # Resume reconciliation for an existing Alert
flux resume alert main
`,
flux resume alert main`,
RunE: resumeAlertCmdRun,
}

3
cmd/flux/resume_helmrelease.go
Unescape Escape View File

@ -29,8 +29,7 @@ var resumeHrCmd = &cobra.Command{
Long: `The resume command marks a previously suspended HelmRelease resource for reconciliation and waits for it to
finish the apply.`,
Example: ` # Resume reconciliation for an existing Helm release
flux resume hr podinfo
`,
flux resume hr podinfo`,
RunE: resumeCommand{
apiType: helmReleaseType,
object: helmReleaseAdapter{&helmv2.HelmRelease{}},

3
cmd/flux/resume_image_repository.go
Unescape Escape View File

@ -27,8 +27,7 @@ var resumeImageRepositoryCmd = &cobra.Command{
Short: "Resume a suspended ImageRepository",
Long: `The resume command marks a previously suspended ImageRepository resource for reconciliation and waits for it to finish.`,
Example: ` # Resume reconciliation for an existing ImageRepository
flux resume image repository alpine
`,
flux resume image repository alpine`,
RunE: resumeCommand{
apiType: imageRepositoryType,
object: imageRepositoryAdapter{&imagev1.ImageRepository{}},

3
cmd/flux/resume_image_updateauto.go
Unescape Escape View File

@ -27,8 +27,7 @@ var resumeImageUpdateCmd = &cobra.Command{
Short: "Resume a suspended ImageUpdateAutomation",
Long: `The resume command marks a previously suspended ImageUpdateAutomation resource for reconciliation and waits for it to finish.`,
Example: ` # Resume reconciliation for an existing ImageUpdateAutomation
flux resume image update latest-images
`,
flux resume image update latest-images`,
RunE: resumeCommand{
apiType: imageUpdateAutomationType,
object: imageUpdateAutomationAdapter{&autov1.ImageUpdateAutomation{}},

3
cmd/flux/resume_kustomization.go
Unescape Escape View File

@ -30,8 +30,7 @@ var resumeKsCmd = &cobra.Command{
Long: `The resume command marks a previously suspended Kustomization resource for reconciliation and waits for it to
finish the apply.`,
Example: ` # Resume reconciliation for an existing Kustomization
flux resume ks podinfo
`,
flux resume ks podinfo`,
RunE: resumeCommand{
apiType: kustomizationType,
object: kustomizationAdapter{&kustomizev1.Kustomization{}},

3
cmd/flux/resume_receiver.go
Unescape Escape View File

@ -39,8 +39,7 @@ var resumeReceiverCmd = &cobra.Command{
Long: `The resume command marks a previously suspended Receiver resource for reconciliation and waits for it to
finish the apply.`,
Example: ` # Resume reconciliation for an existing Receiver
flux resume receiver main
`,
flux resume receiver main`,
RunE: resumeReceiverCmdRun,
}

3
cmd/flux/resume_source_bucket.go
Unescape Escape View File

@ -26,8 +26,7 @@ var resumeSourceBucketCmd = &cobra.Command{
Short: "Resume a suspended Bucket",
Long: `The resume command marks a previously suspended Bucket resource for reconciliation and waits for it to finish.`,
Example: ` # Resume reconciliation for an existing Bucket
flux resume source bucket podinfo
`,
flux resume source bucket podinfo`,
RunE: resumeCommand{
apiType: bucketType,
object: &bucketAdapter{&sourcev1.Bucket{}},

3
cmd/flux/resume_source_chart.go
Unescape Escape View File

@ -28,8 +28,7 @@ var resumeSourceHelmChartCmd = &cobra.Command{
Short: "Resume a suspended HelmChart",
Long: `The resume command marks a previously suspended HelmChart resource for reconciliation and waits for it to finish.`,
Example: ` # Resume reconciliation for an existing HelmChart
flux resume source chart podinfo
`,
flux resume source chart podinfo`,
RunE: resumeCommand{
apiType: helmChartType,
object: &helmChartAdapter{&sourcev1.HelmChart{}},

3
cmd/flux/resume_source_git.go
Unescape Escape View File

@ -26,8 +26,7 @@ var resumeSourceGitCmd = &cobra.Command{
Short: "Resume a suspended GitRepository",
Long: `The resume command marks a previously suspended GitRepository resource for reconciliation and waits for it to finish.`,
Example: ` # Resume reconciliation for an existing GitRepository
flux resume source git podinfo
`,
flux resume source git podinfo`,
RunE: resumeCommand{
apiType: gitRepositoryType,
object: gitRepositoryAdapter{&sourcev1.GitRepository{}},

3
cmd/flux/resume_source_helm.go
Unescape Escape View File

@ -26,8 +26,7 @@ var resumeSourceHelmCmd = &cobra.Command{
Short: "Resume a suspended HelmRepository",
Long: `The resume command marks a previously suspended HelmRepository resource for reconciliation and waits for it to finish.`,
Example: ` # Resume reconciliation for an existing HelmRepository
flux resume source helm bitnami
`,
flux resume source helm bitnami`,
RunE: resumeCommand{
apiType: helmRepositoryType,
object: helmRepositoryAdapter{&sourcev1.HelmRepository{}},

3
cmd/flux/suspend_alert.go
Unescape Escape View File

@ -32,8 +32,7 @@ var suspendAlertCmd = &cobra.Command{
Short: "Suspend reconciliation of Alert",
Long: "The suspend command disables the reconciliation of a Alert resource.",
Example: ` # Suspend reconciliation for an existing Alert
flux suspend alert main
`,
flux suspend alert main`,
RunE: suspendAlertCmdRun,
}

3
cmd/flux/suspend_helmrelease.go
Unescape Escape View File

@ -27,8 +27,7 @@ var suspendHrCmd = &cobra.Command{
Short: "Suspend reconciliation of HelmRelease",
Long: "The suspend command disables the reconciliation of a HelmRelease resource.",
Example: ` # Suspend reconciliation for an existing Helm release
flux suspend hr podinfo
`,
flux suspend hr podinfo`,
RunE: suspendCommand{
apiType: helmReleaseType,
object: &helmReleaseAdapter{&helmv2.HelmRelease{}},

3
cmd/flux/suspend_image_repository.go
Unescape Escape View File

@ -27,8 +27,7 @@ var suspendImageRepositoryCmd = &cobra.Command{
Short: "Suspend reconciliation of an ImageRepository",
Long: "The suspend image repository command disables the reconciliation of a ImageRepository resource.",
Example: ` # Suspend reconciliation for an existing ImageRepository
flux suspend image repository alpine
`,
flux suspend image repository alpine`,
RunE: suspendCommand{
apiType: imageRepositoryType,
object: imageRepositoryAdapter{&imagev1.ImageRepository{}},

3
cmd/flux/suspend_image_updateauto.go
Unescape Escape View File

@ -27,8 +27,7 @@ var suspendImageUpdateCmd = &cobra.Command{
Short: "Suspend reconciliation of an ImageUpdateAutomation",
Long: "The suspend image update command disables the reconciliation of a ImageUpdateAutomation resource.",
Example: ` # Suspend reconciliation for an existing ImageUpdateAutomation
flux suspend image update latest-images
`,
flux suspend image update latest-images`,
RunE: suspendCommand{
apiType: imageUpdateAutomationType,
object: imageUpdateAutomationAdapter{&autov1.ImageUpdateAutomation{}},

3
cmd/flux/suspend_kustomization.go
Unescape Escape View File

@ -27,8 +27,7 @@ var suspendKsCmd = &cobra.Command{
Short: "Suspend reconciliation of Kustomization",
Long: "The suspend command disables the reconciliation of a Kustomization resource.",
Example: ` # Suspend reconciliation for an existing Kustomization
flux suspend ks podinfo
`,
flux suspend ks podinfo`,
RunE: suspendCommand{
apiType: kustomizationType,
object: kustomizationAdapter{&kustomizev1.Kustomization{}},

3
cmd/flux/suspend_receiver.go
Unescape Escape View File

@ -32,8 +32,7 @@ var suspendReceiverCmd = &cobra.Command{
Short: "Suspend reconciliation of Receiver",
Long: "The suspend command disables the reconciliation of a Receiver resource.",
Example: ` # Suspend reconciliation for an existing Receiver
flux suspend receiver main
`,
flux suspend receiver main`,
RunE: suspendReceiverCmdRun,
}

3
cmd/flux/suspend_source_bucket.go
Unescape Escape View File

@ -26,8 +26,7 @@ var suspendSourceBucketCmd = &cobra.Command{
Short: "Suspend reconciliation of a Bucket",
Long: "The suspend command disables the reconciliation of a Bucket resource.",
Example: ` # Suspend reconciliation for an existing Bucket
flux suspend source bucket podinfo
`,
flux suspend source bucket podinfo`,
RunE: suspendCommand{
apiType: bucketType,
object: bucketAdapter{&sourcev1.Bucket{}},

3
cmd/flux/suspend_source_chart.go
Unescape Escape View File

@ -27,8 +27,7 @@ var suspendSourceHelmChartCmd = &cobra.Command{
Short: "Suspend reconciliation of a HelmChart",
Long: "The suspend command disables the reconciliation of a HelmChart resource.",
Example: ` # Suspend reconciliation for an existing HelmChart
flux suspend source chart podinfo
`,
flux suspend source chart podinfo`,
RunE: suspendCommand{
apiType: helmChartType,
object: helmChartAdapter{&sourcev1.HelmChart{}},

3
cmd/flux/suspend_source_git.go
Unescape Escape View File

@ -27,8 +27,7 @@ var suspendSourceGitCmd = &cobra.Command{
Short: "Suspend reconciliation of a GitRepository",
Long: "The suspend command disables the reconciliation of a GitRepository resource.",
Example: ` # Suspend reconciliation for an existing GitRepository
flux suspend source git podinfo
`,
flux suspend source git podinfo`,
RunE: suspendCommand{
apiType: gitRepositoryType,
object: gitRepositoryAdapter{&sourcev1.GitRepository{}},

3
cmd/flux/suspend_source_helm.go
Unescape Escape View File

@ -27,8 +27,7 @@ var suspendSourceHelmCmd = &cobra.Command{
Short: "Suspend reconciliation of a HelmRepository",
Long: "The suspend command disables the reconciliation of a HelmRepository resource.",
Example: ` # Suspend reconciliation for an existing HelmRepository
flux suspend source helm bitnami
`,
flux suspend source helm bitnami`,
RunE: suspendCommand{
apiType: helmRepositoryType,
object: helmRepositoryAdapter{&sourcev1.HelmRepository{}},

3
cmd/flux/uninstall.go
Unescape Escape View File

@ -44,8 +44,7 @@ var uninstallCmd = &cobra.Command{
flux uninstall --namespace=flux-system
# Uninstall Flux but keep the namespace
flux uninstall --namespace=infra --keep-namespace=true
`,
flux uninstall --namespace=infra --keep-namespace=true`,
RunE: uninstallCmdRun,
}

4
docs/cmd/flux.md
Unescape Escape 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

25
docs/cmd/flux_bootstrap_github.md
Unescape Escape 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

19
docs/cmd/flux_bootstrap_gitlab.md
Unescape Escape 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

1
docs/cmd/flux_check.md
Unescape Escape View File

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

1
docs/cmd/flux_completion_bash.md
Unescape Escape 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

1
docs/cmd/flux_completion_fish.md
Unescape Escape 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

1
docs/cmd/flux_completion_powershell.md
Unescape Escape View File

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

1
docs/cmd/flux_completion_zsh.md
Unescape Escape 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

1
docs/cmd/flux_create_alert-provider.md
Unescape Escape 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

1
docs/cmd/flux_create_alert.md
Unescape Escape View File

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

Some files were not shown because too many files have changed in this diff Show More

Write Preview
Loading…
Cancel
Save