Skip to content

Commit

Permalink
Merge pull request #3758 from jenkins-x/regen-plugin-docs-20250219-23…
Browse files Browse the repository at this point in the history
…0932

chore: regenerated plugin docs
  • Loading branch information
jenkins-x-bot authored Feb 19, 2025
2 parents 321ce0d + cafb845 commit a4a812c
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 20 deletions.
12 changes: 8 additions & 4 deletions content/en/v3/develop/reference/jx/gitops/helm/build/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,14 @@ Builds and lints any helm charts
### Options

```
-n, --binary string specifies the helm binary location to use. If not specified defaults to 'helm' on the $PATH
-c, --charts-dir string the directory to look for helm charts to release (default "charts")
-h, --help help for build
--use-helm-plugin uses the jx binary plugin for helm rather than whatever helm is on the $PATH
-n, --binary string specifies the helm binary location to use. If not specified defaults to 'helm' on the $PATH
-c, --charts-dir string the directory to look for helm charts to release (default "charts")
-h, --help help for build
--oci using OCI charts
--registry-config string the path to the registry config for OCI login (default "/tekton/creds-secrets/tekton-container-registry-auth/.dockerconfigjson")
--repo-password string the password to access the chart repository. If not specified defaults to the environment variable $JX_REPOSITORY_PASSWORD
--repo-username string the username to access the chart repository. If not specified defaults to the environment variable $JX_REPOSITORY_USERNAME
--use-helm-plugin uses the jx binary plugin for helm rather than whatever helm is on the $PATH
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Parses a helmfile and any nested helmfiles and validates they conform to a canon

```bash
# Validates helmfile.yaml within the current directory
jx-gitops helmfile validate%!(EXTRA string=jx-gitops)
jx-gitops helmfile validate

```
### Options
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Upgrades the binary plugins for this plugin

```bash
# upgrades your plugin binaries for gitops
jx-gitops plugins upgrade
jx-gitops plugin upgrade

```
### Options
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Post processes kubernetes resources to enrich resources like ServiceAccounts wit
jx-gitops postprocess

# you can register some post processing commands, such as to annotate a ServiceAccount via:
kubectl create secret generic jx-post-process -n default --from-literal=commands="kubectl annotate sa tekton-bot hello=world"%!(EXTRA string=jx-gitops)
kubectl create secret generic jx-post-process -n default --from-literal=commands="kubectl annotate sa tekton-bot hello=world"

```
### Options
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Add one or more repositories to the SourceConfig

```bash
# creates any missing SourceConfig resources
jx-gitops repository add https://github.com/myorg/myrepo.git%!(EXTRA string=jx-gitops)
jx-gitops repository add https://github.com/myorg/myrepo.git

```
### Options
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,6 @@ jx gitops repository create

Creates any missing SourceRepository resources

### Examples

```bash
# creates any missing SourceRepository resources
jx-gitops repository create https://github.com/myorg/myrepo.git%!(EXTRA string=jx-gitops)

```
### Options

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jx gitops repository export

```bash
# creates/populates the .jx/gitops/source-config.yaml file with any SourceRepository resources in the current cluster
jx-gitops repository export%!(EXTRA string=jx-gitops)
jx-gitops repository export

```
### Options
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Adds one or more secrets to the given ServiceAccount files

```bash
# ensures that the given service account resource has the secret associated
jx-gitops sa secret -f config-root/namespaces/jx/mychart/my-sa.yaml --secret my-secret-name%!(EXTRA string=jx-gitops)
jx-gitops sa secret -f config-root/namespaces/jx/mychart/my-sa.yaml --secret my-secret-name

```
### Options
Expand Down
6 changes: 3 additions & 3 deletions content/en/v3/develop/reference/jx/gitops/yset/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Modifies one or more yaml files using a path expression while preserving comment

```bash
# sets the foo.bar=abc in the files *.yaml
jx gitops yset --path foo.bar --value abc *.yaml
jx-gitops yset --path foo.bar --value abc *.yaml

# sets the foo.bar=abc in the file foo.yaml
jx gitops yset --path foo.bar --value abc --file foo.yaml
jx-gitops yset --path foo.bar --value abc --file foo.yaml

# sets the foo.bar=abc in the file foo.yaml and bar.yaml
jx gitops yset --path foo.bar --value abc --file bar.yaml --file foo.yaml%!(EXTRA string=jx-gitops, string=jx-gitops)
jx-gitops --path foo.bar --value abc --file bar.yaml --file foo.yaml

```
### Options
Expand Down

0 comments on commit a4a812c

Please sign in to comment.