From 4f9884d898dcf2d606f7f05bedde818fe6d86e44 Mon Sep 17 00:00:00 2001 From: Automated CI Date: Wed, 27 Nov 2024 14:25:10 +0000 Subject: [PATCH] Publish new documentation for version 0.88.4 --- analyzer/index.html | 42 --------- app-proxy/index.html | 21 ----- audit/download/index.html | 2 +- board/index.html | 7 -- clusters/create-cluster/index.html | 20 +---- clusters/delete-cluster/index.html | 7 -- components/index.html | 7 ++ compositions/index.html | 7 ++ .../create-git-context/index.html | 18 ++-- .../create-secret-store-context/index.html | 89 +++++++++++++++++-- contexts/spec/index.html | 29 ++++++ gitops/install/index.html | 15 ++++ index.json | 12 +-- installation/download/index.html | 12 +-- more/index.html | 70 +++++++-------- pipelines/spec/index.html | 35 ++++++++ predefined-pipelines/index.html | 14 +-- runner-resources/index.html | 35 ++++++++ runtime-environments-base-images/index.html | 56 ------------ runtime-environments/index.html | 14 +-- sections/index.html | 33 ++----- step-types/index.html | 14 +++ teams/synchronize-teams/index.html | 7 ++ triggers/index.html | 14 +-- 24 files changed, 316 insertions(+), 264 deletions(-) diff --git a/analyzer/index.html b/analyzer/index.html index 39215b8ad..dc598d543 100644 --- a/analyzer/index.html +++ b/analyzer/index.html @@ -642,48 +642,6 @@ Agents
  • Annotations
  • Options --file string -/codefresh/volume/cli/codefresh_audit_2024-11-27_08-12-43.csv +/codefresh/volume/cli/codefresh_audit_2024-11-27_14-25-06.csv The name of the file and the directory in which the audit will be saved diff --git a/board/index.html b/board/index.html index 8ef8e3628..b6f4c30c2 100644 --- a/board/index.html +++ b/board/index.html @@ -765,13 +765,6 @@ Audit
    • @@ -1730,14 +1730,6 @@

    github

    Git context are used to clone repositories during pipeline execution.
    Learn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.
    To create Github context you need to generate the token here: https://github.com/settings/tokens.

    -

    gitlab

    - -

    codefresh create context git gitlab <name>

    - -

    Create a gitlab context.

    - -

    Git context are used to clone repositories during pipeline execution.
    Learn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.
    To create gitlab context you need to generate the token here: https://gitlab.com/profile/personal_access_tokens.

    -

    stash

    codefresh create context git stash <name>

    @@ -1746,6 +1738,14 @@

    stash

    Git context are used to clone repositories during pipeline execution.
    Learn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.
    To create Stash context you need to provider username and password.

    +

    gitlab

    + +

    codefresh create context git gitlab <name>

    + +

    Create a gitlab context.

    + +

    Git context are used to clone repositories during pipeline execution.
    Learn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.
    To create gitlab context you need to generate the token here: https://gitlab.com/profile/personal_access_tokens.

    + diff --git a/contexts/create-context/create-secret-store-context/index.html b/contexts/create-context/create-secret-store-context/index.html index 628e1ddef..666c06213 100644 --- a/contexts/create-context/create-secret-store-context/index.html +++ b/contexts/create-context/create-secret-store-context/index.html @@ -1112,6 +1112,62 @@ Runtime-Environments
  • +
    + Registries +
    +
    • @@ -1616,8 +1687,8 @@
    • @@ -1650,14 +1721,6 @@

    hashicorp-vau

    Secret-Store context are used during pipeline execution as API to resolve variables that are parse of Codefresh.

    -

    kubernetes

    - -

    codefresh create context secret-store kubernetes <name>

    - -

    Create a secret-store Kubernetes context.

    - -

    Secret-Store context are used during pipeline execution as API to resolve variables that are parse of Codefresh.

    -

    kubernetes-runtime

    codefresh create context secret-store kubernetes-runtime <name>

    @@ -1666,6 +1729,14 @@

    kube

    Create a secret store to use hybrid runtime to access K8S secret/configmap and use it as secret store.

    +

    kubernetes

    + +

    codefresh create context secret-store kubernetes <name>

    + +

    Create a secret-store Kubernetes context.

    + +

    Secret-Store context are used during pipeline execution as API to resolve variables that are parse of Codefresh.

    + diff --git a/contexts/spec/index.html b/contexts/spec/index.html index 63fb2d574..dc70750a4 100644 --- a/contexts/spec/index.html +++ b/contexts/spec/index.html @@ -1575,6 +1575,35 @@ Registries diff --git a/gitops/install/index.html b/gitops/install/index.html index 92530b007..516ec016f 100644 --- a/gitops/install/index.html +++ b/gitops/install/index.html @@ -1587,6 +1587,21 @@ Delete Registry + +
  • +
    + Registries +
    +
    • diff --git a/index.json b/index.json index 3b92d486b..09f42287b 100644 --- a/index.json +++ b/index.json @@ -900,7 +900,7 @@ "title": "Download", "tags": [], "description": "", - "content": " Description Download audit.\nCommand codefresh download audit\nOptions Option Alias Type Default Description --help Print help information --userName filter by user name --userId filter by codefresh user id --entity filter by api entity, example: pipeline, account --entityId filter by api entity id, this value different for each action, example: email, user id --action filter by api action, get possible values on /api/audit/entitiesList, you will see only actions which was happen in your account --rs_status filter by response status code --showTriggers returns only actions related to receiving triggers --search filter by searching substring in request body or query or params or headers or url --from filter by date, value is number of milliseconds since 1970 --to filter by date, value is number of milliseconds since 1970 --sortField name of sorting field, values: id, createdAt, updatedAt\nPossible values:\n- id\n- createdAt\n- updatedAt --sortType sorting type, values: ASK, DESK\nPossible values:\n- ASK\n- DESK --file string /codefresh/volume/cli/codefresh_audit_2024-11-27_08-12-43.csv The name of the file and the directory in which the audit will be saved Examples undefined codefresh download audit --file /var/www/audit.csv\nundefined --entity account --rs_status 200 --sortType DESK --sortField createdAt\n" + "content": " Description Download audit.\nCommand codefresh download audit\nOptions Option Alias Type Default Description --help Print help information --userName filter by user name --userId filter by codefresh user id --entity filter by api entity, example: pipeline, account --entityId filter by api entity id, this value different for each action, example: email, user id --action filter by api action, get possible values on /api/audit/entitiesList, you will see only actions which was happen in your account --rs_status filter by response status code --showTriggers returns only actions related to receiving triggers --search filter by searching substring in request body or query or params or headers or url --from filter by date, value is number of milliseconds since 1970 --to filter by date, value is number of milliseconds since 1970 --sortField name of sorting field, values: id, createdAt, updatedAt\nPossible values:\n- id\n- createdAt\n- updatedAt --sortType sorting type, values: ASK, DESK\nPossible values:\n- ASK\n- DESK --file string /codefresh/volume/cli/codefresh_audit_2024-11-27_14-25-06.csv The name of the file and the directory in which the audit will be saved Examples undefined codefresh download audit --file /var/www/audit.csv\nundefined --entity account --rs_status 200 --sortType DESK --sortField createdAt\n" }, { "uri": "https://codefresh-io.github.io/cli/more/image-pull-secret/", @@ -949,7 +949,7 @@ "title": "Triggers", "tags": [], "description": "", - "content": " [Deprecated] Create Pipeline Trigger codefresh create trigger [event-uri] [pipeline]\n[Deprecated] Create trigger: link pipeline to trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Get Triggers codefresh get triggers\n[Deprecated] Get triggers, optionally filtered by pipeline or event. Deprecated - please use pipeline spec to manager cron triggers.\nOnly cron/registry triggers are supported (for git triggers use codefresh get pip \u0026lt;pip-name\u0026gt; -o json).\n[Deprecated] Get Trigger Types codefresh get trigger-types\n[Deprecated] Get a list of available trigger-types. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Get Trigger Event codefresh get trigger-events [event-uri]\n[Deprecated] Get trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Delete Pipeline Trigger. Deprecated - please use pipeline spec to manager cron trigger codefresh delete trigger [event-uri] [pipeline]\nDelete trigger: unlink pipeline from trigger-event.\n[Deprecated] Create Trigger Event codefresh create trigger-event\n[Deprecated] Create new trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Delete Trigger Event codefresh delete trigger-event [event-uri]\n[Deprecated] Delete trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n" + "content": " [Deprecated] Create Pipeline Trigger codefresh create trigger [event-uri] [pipeline]\n[Deprecated] Create trigger: link pipeline to trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Get Triggers codefresh get triggers\n[Deprecated] Get triggers, optionally filtered by pipeline or event. Deprecated - please use pipeline spec to manager cron triggers.\nOnly cron/registry triggers are supported (for git triggers use codefresh get pip \u0026lt;pip-name\u0026gt; -o json).\n[Deprecated] Get Trigger Event codefresh get trigger-events [event-uri]\n[Deprecated] Get trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Get Trigger Types codefresh get trigger-types\n[Deprecated] Get a list of available trigger-types. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Delete Pipeline Trigger. Deprecated - please use pipeline spec to manager cron trigger codefresh delete trigger [event-uri] [pipeline]\nDelete trigger: unlink pipeline from trigger-event.\n[Deprecated] Create Trigger Event codefresh create trigger-event\n[Deprecated] Create new trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n[Deprecated] Delete Trigger Event codefresh delete trigger-event [event-uri]\n[Deprecated] Delete trigger-event. Deprecated - please use pipeline spec to manager cron trigger.\n" }, { "uri": "https://codefresh-io.github.io/cli/contexts/update-context/", @@ -1117,7 +1117,7 @@ "title": "Git", "tags": [], "description": "", - "content": " bitbucket codefresh create context git bitbucket \u0026lt;name\u0026gt;\nCreate a bitbucket context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create bitbucket context you need to generate application password from here: https://bitbucket.org/account/user/{YOUR-USERNAME}/app-passwords.\ngithub codefresh create context git github \u0026lt;name\u0026gt;\nCreate a github context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create Github context you need to generate the token here: https://github.com/settings/tokens.\ngitlab codefresh create context git gitlab \u0026lt;name\u0026gt;\nCreate a gitlab context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create gitlab context you need to generate the token here: https://gitlab.com/profile/personal_access_tokens.\nstash codefresh create context git stash \u0026lt;name\u0026gt;\nCreate a stash context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create Stash context you need to provider username and password.\n" + "content": " bitbucket codefresh create context git bitbucket \u0026lt;name\u0026gt;\nCreate a bitbucket context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create bitbucket context you need to generate application password from here: https://bitbucket.org/account/user/{YOUR-USERNAME}/app-passwords.\ngithub codefresh create context git github \u0026lt;name\u0026gt;\nCreate a github context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create Github context you need to generate the token here: https://github.com/settings/tokens.\nstash codefresh create context git stash \u0026lt;name\u0026gt;\nCreate a stash context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create Stash context you need to provider username and password.\ngitlab codefresh create context git gitlab \u0026lt;name\u0026gt;\nCreate a gitlab context.\nGit context are used to clone repositories during pipeline execution.\nLearn more about git context here: https://codefresh.io/docs/docs/codefresh-yaml/steps/git-clone/.\nTo create gitlab context you need to generate the token here: https://gitlab.com/profile/personal_access_tokens.\n" }, { "uri": "https://codefresh-io.github.io/cli/gitops/", @@ -1257,7 +1257,7 @@ "title": "Runtime-Environments", "tags": [], "description": "", - "content": " Get Runtime-Environments codefresh get runtime-environments [name]\nGet a runtime environments configuration.\nDelete Runtime-Environments codefresh delete runtime-environments name\nDelete a runtime-environment.\nApply Runtime-Environments codefresh patch runtime-environments [name]\napply changes to runtime-environments resource.\nUse apply to patch an existing context.\nAttach Runtime-Environments codefresh attach runtime\nAttach a runtime to agent.\nattach runtime.\nCreate Runtime-Environments codefresh create runtime-environments [cluster]\nCreate a runtime environment.\nDiff Runtime-Environments codefresh diff runtime-environments [first-re-name] [first-re-version] [second-re-name] [second-re-version]\nShow diff between two runtime environments configuration.\nInstall Runtime-Environment codefresh install runtime\nInstall and create a runtime on kubernetes cluster.\nUninstall Runtime-Environment codefresh uninstall runtime\nUninstall a runtime on kubernetes cluster.\n" + "content": " Get Runtime-Environments codefresh get runtime-environments [name]\nGet a runtime environments configuration.\nDelete Runtime-Environments codefresh delete runtime-environments name\nDelete a runtime-environment.\nApply Runtime-Environments codefresh patch runtime-environments [name]\napply changes to runtime-environments resource.\nUse apply to patch an existing context.\nAttach Runtime-Environments codefresh attach runtime\nAttach a runtime to agent.\nattach runtime.\nCreate Runtime-Environments codefresh create runtime-environments [cluster]\nCreate a runtime environment.\nDiff Runtime-Environments codefresh diff runtime-environments [first-re-name] [first-re-version] [second-re-name] [second-re-version]\nShow diff between two runtime environments configuration.\nUninstall Runtime-Environment codefresh uninstall runtime\nUninstall a runtime on kubernetes cluster.\nInstall Runtime-Environment codefresh install runtime\nInstall and create a runtime on kubernetes cluster.\n" }, { "uri": "https://codefresh-io.github.io/cli/runtime-environments-base-images/", @@ -1271,7 +1271,7 @@ "title": "Secret-Store", "tags": [], "description": "", - "content": " hashicorp-vault codefresh create context secret-store hashicorp-vault \u0026lt;name\u0026gt;\nCreate a Hashicorp Vault secret-store context.\nSecret-Store context are used during pipeline execution as API to resolve variables that are parse of Codefresh.\nkubernetes codefresh create context secret-store kubernetes \u0026lt;name\u0026gt;\nCreate a secret-store Kubernetes context.\nSecret-Store context are used during pipeline execution as API to resolve variables that are parse of Codefresh.\nkubernetes-runtime codefresh create context secret-store kubernetes-runtime \u0026lt;name\u0026gt;\nCreate a secret-store Kubernetes-Runtime context.\nCreate a secret store to use hybrid runtime to access K8S secret/configmap and use it as secret store.\n" + "content": " hashicorp-vault codefresh create context secret-store hashicorp-vault \u0026lt;name\u0026gt;\nCreate a Hashicorp Vault secret-store context.\nSecret-Store context are used during pipeline execution as API to resolve variables that are parse of Codefresh.\nkubernetes-runtime codefresh create context secret-store kubernetes-runtime \u0026lt;name\u0026gt;\nCreate a secret-store Kubernetes-Runtime context.\nCreate a secret store to use hybrid runtime to access K8S secret/configmap and use it as secret store.\nkubernetes codefresh create context secret-store kubernetes \u0026lt;name\u0026gt;\nCreate a secret-store Kubernetes context.\nSecret-Store context are used during pipeline execution as API to resolve variables that are parse of Codefresh.\n" }, { "uri": "https://codefresh-io.github.io/cli/section/", @@ -1439,7 +1439,7 @@ "title": "Predefined Pipelines", "tags": [], "description": "", - "content": " Delete Helm Release codefresh delete-release \u0026lt;name\u0026gt;\nDelete a helm release from a kubernetes cluster.\nRollback Helm Release codefresh rollback-release \u0026lt;name\u0026gt;\nRollback a helm release from a kubernetes cluster.\nSet Helm config codefresh set-helm-config \u0026lt;cluster\u0026gt;\nSet Helm config.\nInstall or Upgrade Helm Chart codefresh install-chart\nInstall or upgrade a Helm chart Repository flag can be either absolute url or saved repository in Codefresh.\nPromote Helm Release codefresh helm-promotion\nPromote a Helm release in another environment.\nTest Helm Release codefresh test-release \u0026lt;name\u0026gt;\nTest a helm release.\n" + "content": " Delete Helm Release codefresh delete-release \u0026lt;name\u0026gt;\nDelete a helm release from a kubernetes cluster.\nRollback Helm Release codefresh rollback-release \u0026lt;name\u0026gt;\nRollback a helm release from a kubernetes cluster.\nSet Helm config codefresh set-helm-config \u0026lt;cluster\u0026gt;\nSet Helm config.\nPromote Helm Release codefresh helm-promotion\nPromote a Helm release in another environment.\nInstall or Upgrade Helm Chart codefresh install-chart\nInstall or upgrade a Helm chart Repository flag can be either absolute url or saved repository in Codefresh.\nTest Helm Release codefresh test-release \u0026lt;name\u0026gt;\nTest a helm release.\n" }, { "uri": "https://codefresh-io.github.io/cli/cli-config/profiles/", diff --git a/installation/download/index.html b/installation/download/index.html index 525037071..12d08a370 100644 --- a/installation/download/index.html +++ b/installation/download/index.html @@ -1695,12 +1695,12 @@

    Download

    and download the binary that matches your operating system.
    We currently support the following OS:

    +
  • Alpine-x64
    • +
  • Linux-x64
    • +
  • Macos-x64
    • +
  • Windows-x64
    • +
  • Alpine-arm64
    • +
  • Linux-arm64

    • After downloading the binary, untar or unzip it and your are good to go.
    You can also add the binary to your system PATH environment variable so you can use it easily.

    diff --git a/more/index.html b/more/index.html index 4b2feb179..bacaea393 100644 --- a/more/index.html +++ b/more/index.html @@ -1472,67 +1472,67 @@ CLI Config - -
  • -
    - More... - -
    - -
    • -
  • -
    - Teams -
    - +
    • +
  • +
    + More... + +
    +
    • +
  • +
    + Teams +
    + +
  • diff --git a/pipelines/spec/index.html b/pipelines/spec/index.html index 35cca7e5a..f635a977b 100644 --- a/pipelines/spec/index.html +++ b/pipelines/spec/index.html @@ -505,6 +505,41 @@ Spec
    • diff --git a/predefined-pipelines/index.html b/predefined-pipelines/index.html index a6babcb6b..287501965 100644 --- a/predefined-pipelines/index.html +++ b/predefined-pipelines/index.html @@ -1677,8 +1677,8 @@
  • Delete Helm Release
  • Rollback Helm Release
  • Set Helm config
    • -
  • Install or Upgrade Helm Chart
  • Promote Helm Release
    • +
  • Install or Upgrade Helm Chart
  • Test Helm Release
    • @@ -1722,18 +1722,18 @@

    Set Helm conf

    Set Helm config.

    -

    Install or Upgrade Helm Chart

    - -

    codefresh install-chart

    - -

    Install or upgrade a Helm chart Repository flag can be either absolute url or saved repository in Codefresh.

    -

    Promote Helm Release

    codefresh helm-promotion

    Promote a Helm release in another environment.

    +

    Install or Upgrade Helm Chart

    + +

    codefresh install-chart

    + +

    Install or upgrade a Helm chart Repository flag can be either absolute url or saved repository in Codefresh.

    +

    Test Helm Release

    codefresh test-release <name>

    diff --git a/runner-resources/index.html b/runner-resources/index.html index 8200db25e..385dd3ec8 100644 --- a/runner-resources/index.html +++ b/runner-resources/index.html @@ -1051,6 +1051,41 @@ Runner
  • Runtime-Environments
  • Attach Runtime-Environments
  • Create Runtime-Environments
  • Diff Runtime-Environments
    • -
  • Install Runtime-Environment
  • Uninstall Runtime-Environment
    • +
  • Install Runtime-Environment
    • @@ -1746,18 +1746,18 @@

    Install Runtime-Environment

    - -

    codefresh install runtime

    - -

    Install and create a runtime on kubernetes cluster.

    -

    Uninstall Runtime-Environment

    codefresh uninstall runtime

    Uninstall a runtime on kubernetes cluster.

    +

    Install Runtime-Environment

    + +

    codefresh install runtime

    + +

    Install and create a runtime on kubernetes cluster.

    + diff --git a/sections/index.html b/sections/index.html index cb8265540..e51eaa25b 100644 --- a/sections/index.html +++ b/sections/index.html @@ -1188,38 +1188,17 @@ Section