Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _data/home-content.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
icon: images/home-icons/client.svg
url: ''
links:
- title: Codefresh CLI
- title: Download/upgrade Codefresh CLI
localurl: /docs/clients/csdp-cli/


Expand Down
2 changes: 1 addition & 1 deletion _data/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
- title: Clients
url: "/clients"
pages:
- title: Download CLI
- title: Download/upgrade Codefresh CLI
url: "/csdp-cli"


Expand Down
50 changes: 31 additions & 19 deletions _docs/clients/csdp-cli.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
title: "Download CLI"
title: "Download/upgrade Codefresh CLI"
description: ""
group: clients
toc: true
---

You need the Codefresh CLI to install Codefresh runtimes.
* For the initial download, you also need to generate the API key and create the API authentication context, all from the UI.
* Subsequent downloads for upgrade purposes require you to only run the download command, using existing API credentials.
You need the Codefresh CLI to install Codefresh runtimes. For the initial download, you also need to generate the API key and create the API authentication context, all from the UI.
If upgrades are needed, the CLI notifies you through a banner, and you can use the existing API credentials.

### Download Codefresh CLI
Downloading the Codefresh CLI requires you to select the download mode and OS, generate an API key, and authentication context.
Expand All @@ -24,24 +23,37 @@ Downloading the Codefresh CLI requires you to select the download mode and OS, g
url="/images/getting-started/quick-start/quick-start-download-cli.png"
alt="Download CLI to install runtime"
caption="Download CLI to install runtime"
max-width="30%"
max-width="50%"
%}

### Upgrade Codefresh CLI
Upgrade the CLI to the latest version to prevent installation errors.
1. Check the version of the CLI you have installed:
`cf version`
1. Compare with the [latest version](https://github.com/codefresh-io/cli-v2/releases){:target="\_blank"} released by Codefresh.
1. Select and run the appropriate command:

{: .table .table-bordered .table-hover}
| Download mode | OS | Commands |
| -------------- | ----------| ----------|
| `curl` | MacOS-x64 | `curl -L --output - https://github.com/codefresh-io/cli-v2/releases/latest/download/cf-darwin-amd64.tar.gz | tar zx && mv ./cf-darwin-amd64 /usr/local/bin/cf && cf version`|
| | MacOS-m1 |`curl -L --output - https://github.com/codefresh-io/cli-v2/releases/latest/download/cf-darwin-arm64.tar.gz | tar zx && mv ./cf-darwin-arm64 /usr/local/bin/cf && cf version` |
| | Linux - X64 |`curl -L --output - https://github.com/codefresh-io/cli-v2/releases/latest/download/cf-linux-amd64.tar.gz | tar zx && mv ./cf-linux-amd64 /usr/local/bin/cf && cf version` |
| | Linux - ARM | `curl -L --output - https://github.com/codefresh-io/cli-v2/releases/latest/download/cf-linux-arm64.tar.gz | tar zx && mv ./cf-linux-arm64 /usr/local/bin/cf && cf version`|
| `brew` | N/A| `brew tap codefresh-io/cli && brew install cf2`|
The Codefresh CLI automatically self-checks its version, and if a newer version is available, prints a banner with the notification.

{% include
image.html
lightbox="true"
file="/images/runtime/cli-upgrade-banner.png"
url="/images/runtime/cli-upgrade-banner.png"
alt="Upgrade banner for Codefresh CLI"
caption="Upgrade banner for Codefresh CLI"
max-width="50%"
%}

You can upgrade to a specific version if you so require, or download the latest version to an output folder to upgrade at your convenience.


* Do any of the following:
* To upgrade to the latest version, run:
`cf upgrade`
* To upgrade to a specific version, even an older version, run:
`cf upgrade --version v<version-number>`
where:
`<version-number>` is the version you want to upgrade to.
* To download the latest version to an output file, run:
`cf upgrade --version v<version-number> -o <output-file>`
where:
`<output-file>` is the path to the destination file, for example, `/cli-download`.


### Related articles
[Set up hosted (Hosted GitOps) environment]({{site.baseurl}}/docs/runtime/hosted-runtime)
Expand Down
28 changes: 14 additions & 14 deletions _docs/getting-started/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,20 @@ In the hosted environment, the Codefresh Runtime is installed on a K8s cluster m
max-width="100%"
%}

#### Tunnel-based hybrid runtime architecture
Tunnel-based hybrid runtimes use tunneling instead of ingress controllers to control communication between the Codefresh Runtime in the customer cluster and the Codefresh Platform. Tunnel-based, ingress-less, runtimes are optimal when the cluster with the Codefresh Runtime is not exposed to the internet.

{% include
image.html
lightbox="true"
file="/images/getting-started/architecture/arch-hybrid-ingressless.png"
url="/images/getting-started/architecture/arch-hybrid-ingressless.png"
alt="Tunnel-based hybrid runtime architecture"
caption="Tunnel-based hybrid runtime architecture"
max-width="100%"
%}


#### Ingress-based hybrid runtime architecture
Ingress-based runtimes use ingress controllers to control communication between the Codefresh Runtime in the customer cluster and the Codefresh Platform. Ingress-based runtimes are optimal when the cluster with the Codefresh Runtime is exposed to the internet.

Expand All @@ -96,20 +110,6 @@ Ingress-based runtimes use ingress controllers to control communication between
max-width="100%"
%}

#### Tunnel-based hybrid runtime architecture
Tunnel-based hybrid runtimes use tunneling instead of ingress controllers to control communication between the Codefresh Runtime in the customer cluster and the Codefresh Platform. Tunnel-based, ingress-less, runtimes are optimal when the cluster with the Codefresh Runtime is not exposed to the internet.

{% include
image.html
lightbox="true"
file="/images/getting-started/architecture/arch-hybrid-ingressless.png"
url="/images/getting-started/architecture/arch-hybrid-ingressless.png"
alt="Tunnel-based hybrid runtime architecture"
caption="Tunnel-based hybrid runtime architecture"
max-width="100%"
%}



#### Codefresh Application Proxy
The Codefresh Application Proxy (App-Proxy) functions as the Codefresh agent, and is deployed as a service in the Codefresh Runtime.
Expand Down
Loading