Skip to content

Commit

Permalink
chore: regenerated plugin docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Jan 22, 2024
1 parent 2e9db50 commit 2809956
Show file tree
Hide file tree
Showing 14 changed files with 36 additions and 33 deletions.
4 changes: 2 additions & 2 deletions content/en/v3/develop/reference/jx/gitops/annotate/_index.md
Expand Up @@ -34,8 +34,8 @@ Annotates all kubernetes resources in the given directory tree
--dir string the directory to recursively look for the *.yaml or *.yml files (default ".")
-h, --help help for annotate
--invert-selector inverts the effect of selector to exclude resources matched by selector
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--overwrite Set to false to not overwrite any existing value (default true)
-p, --pod-spec annotate the PodSpec in spec.template.metadata.annotations (or spec.jobTemplate.spec.template.metadata.annotations for CronJobs) rather than the top level annotations
--selector stringToString adds Kubernetes label selector to filter on, e.g. -s app=pusher-wave,heritage=Helm (default [])
Expand Down
Expand Up @@ -38,8 +38,8 @@ If supplied with --dir-includes-release-name then by default we will annotate th
--dir-includes-release-name the directory containing the generated resources has a path segment that is the release name
-h, --help help for move
--invert-selector inverts the effect of selector to exclude resources matched by selector
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
-o, --output-dir string the output directory (default "config-root")
--selector stringToString adds Kubernetes label selector to filter on, e.g. -s app=pusher-wave,heritage=Helm (default [])
--selector-target string sets which path in the Kubernetes resources to select on instead of metadata.labels.
Expand Down
Expand Up @@ -28,7 +28,7 @@ Updates the git deployment status after a release

```
-a, --auto-inactive if enabled then the the status of previous deployments will be set to inactive (default true)
--deploy-offset string releases deployed after this time offset will have their deployments updated. Set to empty to update all. Format is a golang duration string (default "2h")
--deploy-offset string releases deployed after this time offset will have their deployments updated. Set to empty to update all. Format is a golang duration string (default "-2h")
-d, --dir string the directory that contains the content (default ".")
-f, --fail if enabled then fail the boot pipeline if we cannot report the deployment status
-h, --help help for status
Expand Down
4 changes: 2 additions & 2 deletions content/en/v3/develop/reference/jx/gitops/image/_index.md
Expand Up @@ -33,8 +33,8 @@ Updates images in the kubernetes resources from the version stream
-d, --dir string the directory that contains the jx-requirements.yml (default ".")
-h, --help help for image
--invert-selector inverts the effect of selector to exclude resources matched by selector
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--log-level string Sets the logging level. If not specified defaults to $JX_LOG_LEVEL
--selector stringToString adds Kubernetes label selector to filter on, e.g. -s app=pusher-wave,heritage=Helm (default [])
--selector-target string sets which path in the Kubernetes resources to select on instead of metadata.labels.
Expand Down
25 changes: 13 additions & 12 deletions content/en/v3/develop/reference/jx/gitops/kpt/update/_index.md
Expand Up @@ -32,18 +32,19 @@ If you know a specific directory which needs updating you can always use 'kpt' d
### Options

```
-b, --batch-mode Runs in batch mode without prompting for user input
--bin string the 'kpt' binary name to use. If not specified this command will download the jx binary plugin into ~/.jx3/plugins/bin and use that
--dir string the directory to recursively look for the *.yaml or *.yml files (default ".")
-h, --help help for update
--ignore-yaml-error ignore kpt errors of the form: yaml: did not find expected node content
--log-level string Sets the logging level. If not specified defaults to $JX_LOG_LEVEL
-o, --owner string filter on the Kptfile repository owner (user/organisation) for which packages to update
-r, --repo string filter on the Kptfile repository name for which packages to update
-s, --strategy string the 'kpt' strategy to use. To see available strategies type 'kpt pkg update --help'. Typical values are: resource-merge, fast-forward, force-delete-replace (default "resource-merge")
-u, --url string filter on the Kptfile repository URL for which packages to update
--verbose Enables verbose output. The environment variable JX_LOG_LEVEL has precedence over this flag and allows setting the logging level to any value of: panic, fatal, error, warn, info, debug, trace
-v, --version string the git version of the kpt package to upgrade to
-b, --batch-mode Runs in batch mode without prompting for user input
--bin string the 'kpt' binary name to use. If not specified this command will download the jx binary plugin into ~/.jx3/plugins/bin and use that
-c, --container-tool string the underlying container tool for kpt to use (default "docker")
--dir string the directory to recursively look for the *.yaml or *.yml files (default ".")
-h, --help help for update
--ignore-yaml-error ignore kpt errors of the form: yaml: did not find expected node content
--log-level string Sets the logging level. If not specified defaults to $JX_LOG_LEVEL
-o, --owner string filter on the Kptfile repository owner (user/organisation) for which packages to update
-r, --repo string filter on the Kptfile repository name for which packages to update
-s, --strategy string the 'kpt' strategy to use. To see available strategies type 'kpt pkg update --help'. Typical values are: resource-merge, fast-forward, force-delete-replace (default "resource-merge")
-u, --url string filter on the Kptfile repository URL for which packages to update
--verbose Enables verbose output. The environment variable JX_LOG_LEVEL has precedence over this flag and allows setting the logging level to any value of: panic, fatal, error, warn, info, debug, trace
-v, --version string the git version of the kpt package to upgrade to
```


Expand Down
4 changes: 2 additions & 2 deletions content/en/v3/develop/reference/jx/gitops/label/_index.md
Expand Up @@ -34,8 +34,8 @@ Labels all kubernetes resources in the given directory tree
--dir string the directory to recursively look for the *.yaml or *.yml files (default ".")
-h, --help help for label
--invert-selector inverts the effect of selector to exclude resources matched by selector
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--overwrite Set to false to not overwrite any existing value (default true)
-p, --pod-spec label the PodSpec in spec.template.metadata.labels (or spec.jobTemplate.spec.template.metadata.labels for CronJobs) rather than the top level labels
--selector stringToString adds Kubernetes label selector to filter on, e.g. -s app=pusher-wave,heritage=Helm (default [])
Expand Down
4 changes: 2 additions & 2 deletions content/en/v3/develop/reference/jx/gitops/namespace/_index.md
Expand Up @@ -38,8 +38,8 @@ Updates all kubernetes resources in the given directory to the given namespace
--dir-mode assumes the first child directory is the name of the namespace to use
-h, --help help for namespace
--invert-selector inverts the effect of selector to exclude resources matched by selector
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
-n, --namespace string the namespace to modify the resources to
--selector stringToString adds Kubernetes label selector to filter on, e.g. -s app=pusher-wave,heritage=Helm (default [])
--selector-target string sets which path in the Kubernetes resources to select on instead of metadata.labels.
Expand Down
Expand Up @@ -37,6 +37,7 @@ Adds a comment to the current pull request
--pr int the Pull Request number. If not specified we detect it via $PULL_NUMBER or $BRANCH_NAME environment variables
-r, --repo string the full git repository name of the form 'owner/name'
--source-url string the git source URL of the repository
-s, --strategy string comment strategy to choose (create, create-if-not-exists, delete-and-create) (default "create")
```


Expand Down
Expand Up @@ -33,8 +33,8 @@ Add one or more repositories to the SourceConfig
-h, --help help for add
--invert-selector inverts the effect of selector to exclude resources matched by selector
-j, --jenkins string the name of the Jenkins server to add the repository to
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--namespace string the namespace to discover SourceRepository resources to default the GitKind. If not specified then use the current namespace
-s, --scheduler string the name of the Scheduler to use for the repository
--selector stringToString adds Kubernetes label selector to filter on, e.g. -s app=pusher-wave,heritage=Helm (default [])
Expand Down
Expand Up @@ -31,8 +31,8 @@ Creates any missing SourceRepository resources
-d, --dir string the directory look for the 'jx-requirements.yml` file (default ".")
-h, --help help for create
--invert-selector inverts the effect of selector to exclude resources matched by selector
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--selector stringToString adds Kubernetes label selector to filter on, e.g. -s app=pusher-wave,heritage=Helm (default [])
--selector-target string sets which path in the Kubernetes resources to select on instead of metadata.labels.
-s, --source-dir string the directory to look for and generate the SourceConfig files
Expand Down
Expand Up @@ -32,8 +32,8 @@ jx gitops repository export
-e, --explicit Explicit mode: always populate all the fields even if they can be deduced. e.g. the git URLs for each repository are not absolutely necessary and are omitted by default are populated if this flag is enabled
-h, --help help for export
--invert-selector inverts the effect of selector to exclude resources matched by selector
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
-n, --namespace string the namespace to look for SourceRepository, SourceRepositoryGroup and Scheduler resources
--selector stringToString adds Kubernetes label selector to filter on, e.g. -s app=pusher-wave,heritage=Helm (default [])
--selector-target string sets which path in the Kubernetes resources to select on instead of metadata.labels.
Expand Down
Expand Up @@ -32,8 +32,8 @@ Resolves the git repository URL for the cluster/environment
-d, --dir string the directory look for the 'jx-requirements.yml` file (default ".")
-h, --help help for resolve
--invert-selector inverts the effect of selector to exclude resources matched by selector
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--selector stringToString adds Kubernetes label selector to filter on, e.g. -s app=pusher-wave,heritage=Helm (default [])
--selector-target string sets which path in the Kubernetes resources to select on instead of metadata.labels.
-s, --source-dir string the directory to recursively look for the *.yaml or *.yml source Environment/SourceRepository files (default ".")
Expand Down
4 changes: 2 additions & 2 deletions content/en/v3/develop/reference/jx/gitops/sa/secret/_index.md
Expand Up @@ -30,8 +30,8 @@ Adds one or more secrets to the given ServiceAccount files
-f, --file string the ServiceAccount file to modify
-h, --help help for secret
--invert-selector inverts the effect of selector to exclude resources matched by selector
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md
-k, --kind stringArray adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
--kind-ignore stringArray adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md
-s, --secret stringArray the Secret names to add to the ServiceAccount
--selector stringToString adds Kubernetes label selector to filter on, e.g. -s app=pusher-wave,heritage=Helm (default [])
--selector-target string sets which path in the Kubernetes resources to select on instead of metadata.labels.
Expand Down
Expand Up @@ -24,6 +24,7 @@ Upgrades the GitOps git repository with the latest configuration and versions th
-b, --batch-mode Runs in batch mode without prompting for user input
--bin string the 'kpt' binary name to use. If not specified this command will download the jx binary plugin into ~/.jx3/plugins/bin and use that
--commit-message string the git commit message used (default "chore: generated kubernetes resources from helm chart")
-c, --container-tool string the underlying container tool for kpt to use (default "docker")
--dir string the directory to recursively look for the *.yaml or *.yml files (default ".")
--git-commit if set then the template command will git commit the modified helmfile.yaml files
--helmfile string the helmfile to resolve. If not specified defaults to 'helmfile.yaml' in the dir
Expand Down

0 comments on commit 2809956

Please sign in to comment.