Skip to content

Commit

Permalink
Publish new documentation for version 0.88.2
Browse files Browse the repository at this point in the history
  • Loading branch information
Automated CI committed Nov 24, 2024
1 parent fd34a1d commit 21d7332
Show file tree
Hide file tree
Showing 20 changed files with 1,366 additions and 364 deletions.
2 changes: 1 addition & 1 deletion audit/download/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1840,7 +1840,7 @@ <h3 id="options">Options</h3>
<td>--file</td>
<td></td>
<td>string</td>
<td>/codefresh/volume/cli/codefresh_audit_2024-08-12_15-14-04.csv</td>
<td>/codefresh/volume/cli/codefresh_audit_2024-11-24_13-20-51.csv</td>
<td>The name of the file and the directory in which the audit will be saved</td>
</tr>
</tbody>
Expand Down
27 changes: 3 additions & 24 deletions boards/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -765,31 +765,10 @@
<a href="/cli/audit/">Audit</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/contexts/create-context/create-config-context/" class="dd-item">
<li data-nav-id="/cli/audit/download/" class="dd-item">
<div>
<a href="/cli/contexts/create-context/create-config-context/">
Config
</a>
</div>
</li>
<li data-nav-id="/cli/contexts/create-context/create-secret-context/" class="dd-item">
<div>
<a href="/cli/contexts/create-context/create-secret-context/">
Secret
</a>
</div>
</li>
<li data-nav-id="/cli/contexts/create-context/create-secret-yaml-context/" class="dd-item">
<div>
<a href="/cli/contexts/create-context/create-secret-yaml-context/">
Secret Yaml
</a>
</div>
</li>
<li data-nav-id="/cli/contexts/create-context/create-yaml-context/" class="dd-item">
<div>
<a href="/cli/contexts/create-context/create-yaml-context/">
Yaml
<a href="/cli/audit/download/">
Download
</a>
</div>
</li>
Expand Down
42 changes: 42 additions & 0 deletions cli-config/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1422,6 +1422,48 @@
<a href="/cli/predefined-pipelines/">Predefined Pipelines</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/predefined-pipelines/delete-helm-release/" class="dd-item">
<div>
<a href="/cli/predefined-pipelines/delete-helm-release/">
Delete Helm Release
</a>
</div>
</li>
<li data-nav-id="/cli/predefined-pipelines/rollback-helm-release/" class="dd-item">
<div>
<a href="/cli/predefined-pipelines/rollback-helm-release/">
Rollback Helm Release
</a>
</div>
</li>
<li data-nav-id="/cli/predefined-pipelines/install-or-upgrade-helm-chart/" class="dd-item">
<div>
<a href="/cli/predefined-pipelines/install-or-upgrade-helm-chart/">
Install or Upgrade Helm Chart
</a>
</div>
</li>
<li data-nav-id="/cli/predefined-pipelines/promote-helm-release/" class="dd-item">
<div>
<a href="/cli/predefined-pipelines/promote-helm-release/">
Promote Helm Release
</a>
</div>
</li>
<li data-nav-id="/cli/predefined-pipelines/set-helm-config/" class="dd-item">
<div>
<a href="/cli/predefined-pipelines/set-helm-config/">
Set Helm config
</a>
</div>
</li>
<li data-nav-id="/cli/predefined-pipelines/test-helm-release/" class="dd-item">
<div>
<a href="/cli/predefined-pipelines/test-helm-release/">
Test Helm Release
</a>
</div>
</li>
</ul>
</li>
<li data-nav-id="/cli/cli-config/" class="dd-item parent active haschildren
Expand Down
34 changes: 3 additions & 31 deletions clusters/create-cluster/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -854,38 +854,10 @@
<a href="/cli/codefresh-cli-components/">Codefresh CLI components</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/contexts/spec/config/" class="dd-item">
<div>
<a href="/cli/contexts/spec/config/">
Config
</a>
</div>
</li>
<li data-nav-id="/cli/contexts/spec/secret/" class="dd-item">
<li data-nav-id="/cli/codefresh-cli-components/components/" class="dd-item">
<div>
<a href="/cli/contexts/spec/secret/">
Secret
</a>
</div>
</li>
<li data-nav-id="/cli/contexts/spec/yaml/" class="dd-item">
<div>
<a href="/cli/contexts/spec/yaml/">
Yaml
</a>
</div>
</li>
<li data-nav-id="/cli/contexts/spec/secret-yaml/" class="dd-item">
<div>
<a href="/cli/contexts/spec/secret-yaml/">
Secret Yaml
</a>
</div>
</li>
<li data-nav-id="/cli/contexts/spec/helm-repository/" class="dd-item">
<div>
<a href="/cli/contexts/spec/helm-repository/">
Helm Repository
<a href="/cli/codefresh-cli-components/components/">
components
</a>
</div>
</li>
Expand Down
21 changes: 21 additions & 0 deletions codefresh-cli-components/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -824,6 +824,27 @@
<a href="/cli/clusters/">Clusters</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/clusters/get-clusters/" class="dd-item">
<div>
<a href="/cli/clusters/get-clusters/">
Get Clusters
</a>
</div>
</li>
<li data-nav-id="/cli/clusters/delete-cluster/" class="dd-item">
<div>
<a href="/cli/clusters/delete-cluster/">
Delete Cluster
</a>
</div>
</li>
<li data-nav-id="/cli/clusters/create-cluster/" class="dd-item">
<div>
<a href="/cli/clusters/create-cluster/">
Create Cluster
</a>
</div>
</li>
</ul>
</li>
<li data-nav-id="/cli/codefresh-cli-components/" class="dd-item parent active haschildren
Expand Down
18 changes: 9 additions & 9 deletions contexts/create-context/create-git-context/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1688,8 +1688,8 @@
<ul>
<li><a href="#bitbucket-bitbucket"><a href="bitbucket">bitbucket</a></a></li>
<li><a href="#github-github"><a href="github">github</a></a></li>
<li><a href="#gitlab-gitlab"><a href="gitlab">gitlab</a></a></li>
<li><a href="#stash-stash"><a href="stash">stash</a></a></li>
<li><a href="#gitlab-gitlab"><a href="gitlab">gitlab</a></a></li>
</ul></li>
</ul></li>
</ul>
Expand Down Expand Up @@ -1730,14 +1730,6 @@ <h3 id="github-github"><a href="github">github</a></h3>

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

<h3 id="gitlab-gitlab"><a href="gitlab">gitlab</a></h3>

<p><code>codefresh create context git gitlab &lt;name&gt;</code></p>

<p>Create a gitlab context.</p>

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

<h3 id="stash-stash"><a href="stash">stash</a></h3>

<p><code>codefresh create context git stash &lt;name&gt;</code></p>
Expand All @@ -1746,6 +1738,14 @@ <h3 id="stash-stash"><a href="stash">stash</a></h3>

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

<h3 id="gitlab-gitlab"><a href="gitlab">gitlab</a></h3>

<p><code>codefresh create context git gitlab &lt;name&gt;</code></p>

<p>Create a gitlab context.</p>

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




Expand Down
25 changes: 16 additions & 9 deletions contexts/create-context/create-secret-store-context/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1097,6 +1097,13 @@
<a href="/cli/runner-resources/">Runner Resources</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/runner-resources/runner/" class="dd-item">
<div>
<a href="/cli/runner-resources/runner/">
Runner
</a>
</div>
</li>
</ul>
</li>
<li data-nav-id="/cli/runtime-environments/" class="dd-item haschildren
Expand Down Expand Up @@ -1680,8 +1687,8 @@
<li>
<ul>
<li><a href="#hashicorp-vault-hashicorp-vault"><a href="hashicorp-vault">hashicorp-vault</a></a></li>
<li><a href="#kubernetes-runtime-kubernetes-runtime"><a href="kubernetes-runtime">kubernetes-runtime</a></a></li>
<li><a href="#kubernetes-kubernetes"><a href="kubernetes">kubernetes</a></a></li>
<li><a href="#kubernetes-runtime-kubernetes-runtime"><a href="kubernetes-runtime">kubernetes-runtime</a></a></li>
</ul></li>
</ul></li>
</ul>
Expand Down Expand Up @@ -1714,14 +1721,6 @@ <h3 id="hashicorp-vault-hashicorp-vault"><a href="hashicorp-vault">hashicorp-vau

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

<h3 id="kubernetes-runtime-kubernetes-runtime"><a href="kubernetes-runtime">kubernetes-runtime</a></h3>

<p><code>codefresh create context secret-store kubernetes-runtime &lt;name&gt;</code></p>

<p>Create a secret-store Kubernetes-Runtime context.</p>

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

<h3 id="kubernetes-kubernetes"><a href="kubernetes">kubernetes</a></h3>

<p><code>codefresh create context secret-store kubernetes &lt;name&gt;</code></p>
Expand All @@ -1730,6 +1729,14 @@ <h3 id="kubernetes-kubernetes"><a href="kubernetes">kubernetes</a></h3>

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

<h3 id="kubernetes-runtime-kubernetes-runtime"><a href="kubernetes-runtime">kubernetes-runtime</a></h3>

<p><code>codefresh create context secret-store kubernetes-runtime &lt;name&gt;</code></p>

<p>Create a secret-store Kubernetes-Runtime context.</p>

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




Expand Down
21 changes: 7 additions & 14 deletions contexts/create-context/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -855,6 +855,13 @@
<a href="/cli/codefresh-cli-components/">Codefresh CLI components</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/codefresh-cli-components/components/" class="dd-item">
<div>
<a href="/cli/codefresh-cli-components/components/">
components
</a>
</div>
</li>
</ul>
</li>
<li data-nav-id="/cli/components/" class="dd-item haschildren
Expand All @@ -863,20 +870,6 @@
<a href="/cli/components/">Components</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/components/download/" class="dd-item">
<div>
<a href="/cli/components/download/">
Download
</a>
</div>
</li>
<li data-nav-id="/cli/components/update/" class="dd-item">
<div>
<a href="/cli/components/update/">
Update
</a>
</div>
</li>
</ul>
</li>
<li data-nav-id="/cli/environments/" class="dd-item haschildren
Expand Down
29 changes: 29 additions & 0 deletions contexts/spec/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1575,6 +1575,35 @@
<a href="/cli/registries/">Registries</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/registries/get-registries/" class="dd-item">
<div>
<a href="/cli/registries/get-registries/">
Get Registries
</a>
</div>
</li>
<li data-nav-id="/cli/registries/delete-registry/" class="dd-item">
<div>
<a href="/cli/registries/delete-registry/">
Delete Registry
</a>
</div>
</li>
<li data-nav-id="/cli/registries/registries/" class="dd-item haschildren
">
<div>
<a href="/cli/registries/registries/">Registries</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/registries/registries/standard/" class="dd-item">
<div>
<a href="/cli/registries/registries/standard/">
standard
</a>
</div>
</li>
</ul>
</li>
</ul>
</li>

Expand Down
31 changes: 12 additions & 19 deletions contexts/spec/secret-yaml/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,38 +132,31 @@
<a href="/cli/authentication/">Authentication</a><i class="fa fa-angle-right fa-lg category-icon"></i>
</div>
<ul>
<li data-nav-id="/cli/contexts/spec/config/" class="dd-item">
<li data-nav-id="/cli/authentication/get-contexts/" class="dd-item">
<div>
<a href="/cli/contexts/spec/config/">
Config
<a href="/cli/authentication/get-contexts/">
Get Contexts
</a>
</div>
</li>
<li data-nav-id="/cli/contexts/spec/secret/" class="dd-item">
<li data-nav-id="/cli/authentication/create-context/" class="dd-item">
<div>
<a href="/cli/contexts/spec/secret/">
Secret
<a href="/cli/authentication/create-context/">
Create Context
</a>
</div>
</li>
<li data-nav-id="/cli/contexts/spec/yaml/" class="dd-item">
<li data-nav-id="/cli/authentication/get-activated-context/" class="dd-item">
<div>
<a href="/cli/contexts/spec/yaml/">
Yaml
<a href="/cli/authentication/get-activated-context/">
Get Activated Context
</a>
</div>
</li>
<li data-nav-id="/cli/contexts/spec/secret-yaml/" class="dd-item active">
<li data-nav-id="/cli/authentication/set-active-context/" class="dd-item">
<div>
<a href="/cli/contexts/spec/secret-yaml/">
Secret Yaml
</a>
</div>
</li>
<li data-nav-id="/cli/contexts/spec/helm-repository/" class="dd-item">
<div>
<a href="/cli/contexts/spec/helm-repository/">
Helm Repository
<a href="/cli/authentication/set-active-context/">
Set Active Context
</a>
</div>
</li>
Expand Down
Loading

0 comments on commit 21d7332

Please sign in to comment.