From a6b4f5e25068cc9dfa91731b7f5a9b6ab8cc0e7d Mon Sep 17 00:00:00 2001 From: github-actions Date: Thu, 10 Oct 2024 23:10:08 +0000 Subject: [PATCH] chore: regenerated plugin docs Created by this action run: https://github.com/jenkins-x/jx-docs/actions/runs/11283346937 --- .../reference/jx/admin/create/_index.md | 1 + .../reference/jx/admin/operator/_index.md | 1 + .../develop/reference/jx/admin/stop/_index.md | 37 +++++++++++++++++++ 3 files changed, 39 insertions(+) create mode 100644 content/en/v3/develop/reference/jx/admin/stop/_index.md diff --git a/content/en/v3/develop/reference/jx/admin/create/_index.md b/content/en/v3/develop/reference/jx/admin/create/_index.md index b6dc5e7a7ca..bb309e4a46b 100644 --- a/content/en/v3/develop/reference/jx/admin/create/_index.md +++ b/content/en/v3/develop/reference/jx/admin/create/_index.md @@ -72,6 +72,7 @@ Creates a new git repository for a new Jenkins X installation --repository string the artifact repository. Possible values are: none, bucketrepo, nexus, artifactory -r, --requirements string The 'jx-requirements.yml' file to use in the created development git repository. This file may be created via terraform --secret string configures the secret storage kind. Possible values: local, vault + --skip-namespace-creation if enabled skip namespace creation --tls enable TLS for Ingress --tls-email string the TLS email address to enable TLS on the domain --tls-production the LetsEncrypt production service, defaults to true, set to false to use the Staging service (default true) diff --git a/content/en/v3/develop/reference/jx/admin/operator/_index.md b/content/en/v3/develop/reference/jx/admin/operator/_index.md index 55a642ac7c6..314608c4e55 100644 --- a/content/en/v3/develop/reference/jx/admin/operator/_index.md +++ b/content/en/v3/develop/reference/jx/admin/operator/_index.md @@ -59,6 +59,7 @@ Installs the git operator in a cluster --no-switch-namespace to disable switching to the installation namespace after installing the operator --set stringArray one or more helm set arguments to pass through the git operator chart. Equivalent to running 'helm install --set some.name=value' --setup stringArray a git configuration command to configure git inside the git operator pod to deal with things like insecure docker registries etc. e.g. supply 'git config --global http.sslverify false' to disable TLS verification + --skip-namespace-creation if enabled skip namespace creation --token string specify the git token the operator will use to clone the environment git repository if there is no password in the git URL. If not specified defaults to $GIT_TOKEN -u, --url string the git URL for the environment to boot using the operator. This is optional - the git operator Secret can be created later --username string specify the git user name the operator will use to clone the environment git repository if there is no username in the git URL. If not specified defaults to $GIT_USERNAME diff --git a/content/en/v3/develop/reference/jx/admin/stop/_index.md b/content/en/v3/develop/reference/jx/admin/stop/_index.md new file mode 100644 index 00000000000..32c35c74c2b --- /dev/null +++ b/content/en/v3/develop/reference/jx/admin/stop/_index.md @@ -0,0 +1,37 @@ +--- +title: jx admin stop +linktitle: stop +type: docs +description: "stops the currently running boot Job ***Aliases**: suspend*" +aliases: + - jx-admin_stop +--- + +### Usage + +``` +jx admin stop +``` + +### Synopsis + +Stops the currently running boot Job. + +It works by setting spec.suspend=true in the job. + +### Options + +``` + -b, --batch-mode Runs in batch mode without prompting for user input + -h, --help help for stop + --log-level string Sets the logging level. If not specified defaults to $JX_LOG_LEVEL + -n, --namespace string the namespace where the boot jobs run. If not specified it will look in: jx-git-operator and jx + -s, --selector string the selector of the boot Job pods (default "app=jx-boot") + --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 +``` + + + +### Source + +[jenkins-x-plugins/jx-admin](https://github.com/jenkins-x-plugins/jx-admin)