Skip to content

Commit

Permalink
Gitops remove hosted runtime (#1132)
Browse files Browse the repository at this point in the history
* Remove Hosted Runtime entries

Removed Hosted Runtime entries from nav yamls and from topics except Gerrit

* Undo commented out from comparison table

Removed commented out from Hybrid vs. Hosted comparison table

* Update after review

Minor content updates
  • Loading branch information
NimRegev authored Dec 24, 2024
1 parent 73f1b24 commit d4d3f6b
Show file tree
Hide file tree
Showing 10 changed files with 50 additions and 48 deletions.
2 changes: 0 additions & 2 deletions _data/home-content.yml
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,6 @@
localurl: /docs/installation/installation-options/on-premises/codefresh-on-prem-upgrade/
- title: Codefresh Runner installation
localurl: /docs/installation/runner/
- title: Hosted GitOps Runtime installation
localurl: /docs/installation/gitops/hosted-runtime/
- title: Hybrid GitOps Runtime installation
localurl: /docs/installation/gitops/hybrid-gitops-helm-installation/
- title: Migrate Hybrid GitOps Runtimes from CLI to Helm
Expand Down
2 changes: 0 additions & 2 deletions _data/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -583,8 +583,6 @@
sub-pages:
- title: GitOps Runtime architecture
url: "/runtime-architecture"
- title: Hosted GitOps Runtime
url: "/hosted-runtime"
- title: Hybrid GitOps Runtime
url: "/hybrid-gitops-helm-installation"
- title: Hybrid GitOps Runtime alongside Community Argo CD
Expand Down
17 changes: 11 additions & 6 deletions _docs/installation/gitops.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Codefresh GitOps offers native support for Argo CD, while serving as an active m
Our GitOps Runtime solves these issues with unique benefits.


GitOps Runtimes come in two options:
<!--- GitOps Runtimes come in two options:
* Hosted Runtimes with Argo CD installed within the Codefresh cluster (see [Hosted GitOps](#hosted-gitops))
* Hybrid Runtimes with Argo CD installed within the customer's cluster (see [Hybrid GitOps](#hybrid-gitops))
* Hybrid Runtimes with Argo CD installed within the customer's cluster (see [Hybrid GitOps](#hybrid-gitops)) -->

Explore the [benefits](#benefits-of-gitops-runtimes) of GitOps Runtimes, and [compare their features/functionality](#hosted-vshybrid-gitops).

Expand Down Expand Up @@ -43,7 +43,7 @@ Explore the [benefits](#benefits-of-gitops-runtimes) of GitOps Runtimes, and [co
Administrative functionality for user, permission, and audit management is centralized and Argo CD agnostic.


## Hosted GitOps
<!--- ## Hosted GitOps
The SaaS version of GitOps, Hosted GitOps has Argo CD installed in the Codefresh cluster.
Hosted GitOps Runtime is installed and provisioned in a Codefresh cluster, and managed by Codefresh.
Expand All @@ -62,7 +62,7 @@ For the architecture, see [Hosted GitOps Runtime architecture]({{site.baseurl}}/
max-width="80%"
%}
For more information on how to set up the hosted environment, including provisioning hosted runtimes, see [Set up Hosted GitOps]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/).
For more information on how to set up the hosted environment, including provisioning hosted runtimes, see [Set up Hosted GitOps]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/). -->

## Hybrid GitOps
The hybrid version of GitOps, has Argo CD installed in the customer's cluster.
Expand All @@ -86,11 +86,16 @@ Hybrid GitOps Runtime installation includes a forked version of the Argo Project
max-width="70%"
%}

For more information on Hybrid GitOps, see [Hybrid GitOps Runtime requirements]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/#minimum-system-requirements) and [Hybrid GitOps Runtime installation]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/).
For more information on Hybrid GitOps Runtimes, see [Hybrid GitOps Runtime requirements]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/#minimum-system-requirements) and [Hybrid GitOps Runtime installation]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/).



## Hosted vs.Hybrid GitOps

>**NOTE**
We have deprecated Hosted GitOps Runtimes which are no longer supported.
The comparison below is provided for historical reference only.

The table below highlights the main differences between Hosted and Hybrid GitOps.

{: .table .table-bordered .table-hover}
Expand All @@ -114,7 +119,7 @@ The table below highlights the main differences between Hosted and Hybrid GitOps
|Integrations | | Supported | Supported |
|Dashboards |Home | Hosted Runtime and deployments|Runtimes, deployments, Delivery Pipelines |
| |DORA metrics | Supported |Supported |
| |Applications | Supported |Supported |
| |Applications | Supported |Supported |


## Related articles
Expand Down
4 changes: 1 addition & 3 deletions _docs/installation/gitops/git-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@ group: installation
toc: true
---

>**NOTE**
This feature is currently in Beta.

A Git Source is a unique entity created for use with GitOps Runtimes in Codefresh.

The Git Source connects to a Git repository within your organization, serving as an easy way to manage the deployment and configuration of Argo CD applications on clusters.
The Git repository referenced by the Git Source stores application manifests and other resources. All resources in the Git repo are always synced to the cluster. Codefresh manages the Git Source itself as an Argo CD application.
The Git repository referenced by the Git Source stores application manifests and other resources which are always synced to the cluster. Codefresh manages the Git Source itself as an Argo CD application.

<br>

Expand Down
8 changes: 4 additions & 4 deletions _docs/installation/gitops/hybrid-gitops-helm-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ The CLI-based installation for Hybrid GitOps is considered legacy. We will depre
You can migrate existing CLI-based GitOps Runtimes to Helm-based ones, as described in [Migrating GitOps Runtimes from CLI to Helm]({{site.baseurl}}/docs/installation/gitops/migrate-cli-runtimes-helm/).
{{site.data.callout.end}}

For GitOps, Codefresh offers the option of installing Hosted and Hybrid GitOps Runtimes. For a comparison, see [Hosted vs. Hybrid GitOps]({{site.baseurl}}/docs/installation/gitops/#hosted-vshybrid-gitops).
<!--- For GitOps, Codefresh offers the option of installing Hosted and Hybrid GitOps Runtimes. For a comparison, see [Hosted vs. Hybrid GitOps]({{site.baseurl}}/docs/installation/gitops/#hosted-vshybrid-gitops). -->


This article walks you through the process of installing Hybrid GitOps Runtimes in your Codefresh accounts using Helm charts on a _clean cluster_. You can install a single GitOps Runtime on a cluster. To install additional Runtimes in the same account, each account must be on a different cluster. Every Runtime within your account must have a unique name.

For Hosted GitOps Runtimes, see [Hosted GitOps Runtime Setup]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/).
<!--- For Hosted GitOps Runtimes, see [Hosted GitOps Runtime Setup]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/). --->

##### Number of Hybrid GitOps Runtimes
Within the same account, you can install _one Hosted and one Hybrid GitOps Runtime on a cluster_.
Within the same account, you can install one Hybrid GitOps Runtime on a cluster.
For additional Hybrid GitOps Runtimes in the same account, each Runtime must be installed on a different cluster, and must have a unique name.

##### Installation options for GitOps Runtimes
Expand Down Expand Up @@ -864,7 +864,7 @@ You can [monitor]({{site.baseurl}}/docs/deployments/gitops/applications-dashboar
|Git access tokens | {::nomarkdown}Git runtime token:<ul><li>Valid expiration date</li><li><a href="https://codefresh.io/docs/docs/security/git-tokens/#git-runtime-token-scopes">Scopes</a> </li></ul></ul>{:/}|
| |Git user token:{::nomarkdown}<ul><li>Valid expiration date</li><li><a href="https://codefresh.io/docs/docs/security/git-tokens/#git-user-access-token-scopes">Scopes</a> </li></ul>{:/}|

For a comparison between Hosted and Hybrid GitOps Runtimes, see [Hosted vs. hybrid GitOps]({{site.baseurl}}/docs/installation/installation-options/#hosted-vshybrid-gitops).
<!--- For a comparison between Hosted and Hybrid GitOps Runtimes, see [Hosted vs. hybrid GitOps]({{site.baseurl}}/docs/installation/installation-options/#hosted-vshybrid-gitops). -->

## Upgrade Runtimes
For upgrade instructions, see [Upgrade GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#hybrid-gitops-upgrade-gitops-runtimes/).
Expand Down
4 changes: 2 additions & 2 deletions _docs/installation/gitops/managed-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sub_group: gitops
toc: true
---

Once you have an Argo CD installation as part of a [Hybrid]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation//) or [Hosted]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/) GitOps Runtime, you can add external clusters to them. You can then deploy applications to those clusters without having to install Argo CD on the clusters in order to do so.
Once you have an Argo CD installation as part of a [Hybrid]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation//) <!--- or [Hosted]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/) -->GitOps Runtime, you can add external clusters to them. You can then deploy applications to those clusters without having to install Argo CD on the clusters in order to do so.

When you add an external cluster to a provisioned GitOps Runtime, the cluster is registered as a managed cluster. A managed cluster is treated as any other managed K8s resource, meaning that you can monitor its health and sync status, deploy applications to it, view information in the Applications dashboard, and remove the cluster from the Runtime's managed list.

Expand All @@ -17,7 +17,7 @@ Adding a managed cluster via Codefresh ensures that Codefresh applies the requir

## Prerequisites

* For _Hosted GitOps_ Runtimes: [Configure access to these IP addresses]({{site.baseurl}}/docs/administration/platform-ip-addresses/)
<!--- * For _Hosted GitOps_ Runtimes: [Configure access to these IP addresses]({{site.baseurl}}/docs/administration/platform-ip-addresses/) -->
* Valid Git personal access token with the [required scopes]({{site.baseurl}}/docs/security/git-tokens/)
* [Latest version of the Codefresh CLI]({{site.baseurl}}/docs/installation/gitops/upgrade-gitops-cli/)
* Codefresh token in user settings
Expand Down
16 changes: 8 additions & 8 deletions _docs/installation/gitops/monitor-manage-runtimes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ toc: true
---


The **Runtimes** page displays the provisioned GitOps Runtimes in your account, both Hybrid Runtimes, and the Hosted Runtime if you have one.
The **Runtimes** page displays the provisioned GitOps Runtimes in your account<!---, both Hybrid Runtimes, and the Hosted Runtime if you have one -->.

View Runtime components and information in [List or Topology view formats](/#gitops-runtime-views) to manage and monitor them.

Expand All @@ -25,10 +25,10 @@ View Runtime components and information in [List or Topology view formats](/#git
%}


{{site.data.callout.callout_tip}}
<!--- {{site.data.callout.callout_tip}}
**TIP**
Unless specified otherwise, all options are common to both types of GitOps Runtimes. If an option is valid only for Hybrid GitOps, it is indicated as such.
{{site.data.callout.end}}
{{site.data.callout.end}} -->

{{site.data.callout.callout_warning}}
**WARNING**
Expand Down Expand Up @@ -66,9 +66,9 @@ Here is a description of the information in the List View.
| List View Item| Description |
| -------------- | ---------------- |
|**Name**| The name of the provisioned GitOps Runtime.<br>Hybrid GitOps Runtimes installed with Helm show the status as either Online (green dot) or Offline (red dot). |
|**Type**| The type of GitOps Runtime provisioned, and can be either **Hosted** or **Helm**.<br>**Config Runtime** indicates that the Runtime has been designated to store platform resources. See [Designating Configuration Runtimes](#designating-configuration-runtimes) |
|**Type**| The type of GitOps Runtime provisioned, and is **Helm**<!--- can be either **Hosted** or **Helm**-->.<br>**Config Runtime** indicates that the Runtime has been designated to store platform resources. See [Designating Configuration Runtimes](#designating-configuration-runtimes) |
|**Cluster/Namespace**| The K8s API server endpoint, as well as the namespace with the cluster. |
|**Modules**| The modules installed based on the type of provisioned Runtime. Hybrid GitOps (both Helm and CLI) Runtimes include CI and CD Ops modules. Hosted runtimes include CD Ops. |
|**Modules**| The modules installed based on the type of provisioned Runtime. Hybrid GitOps Runtimes include CI and CD Ops modules. <!--- Hosted runtimes include CD Ops.--> |
|**Managed Cluster**| The number of managed clusters, if any, registered with the GitOps Runtime. To view list of managed clusters, click the runtime name, and then the **Managed Clusters** tab. To work with managed clusters, see [Adding external clusters to runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/).|
|**Version**| The version of the Runtime currently installed, and the version of the Helm chart in parentheses. <br><br>**Update Available!** indicates there are newer versions of the Runtime, Helm chart, or both. <br>To see all the commits and changes for the version, mouse over **Update Available!**, and select **View Complete Change Log**. <br> See:<br>[Upgrade GitOps Runtimes](#hybrid-gitops-upgrade-gitops-runtimes)<br>[View changelogs for GitOps Runtimes](#changelog-for-all-runtime-releases)<br>[Rollback GitOps Runtimes](#hybrid-gitops-rollback-gitops-runtimes) |
|**Last Updated**| The most recent update information from the runtime to the Codefresh platform. Updates are sent to the platform typically every few minutes. Longer update intervals may indicate networking issues.|
Expand Down Expand Up @@ -96,13 +96,13 @@ Here is a description of the information in the Topology view.
{: .table .table-bordered .table-hover}
| Topology View Item | Description |
| ------------------------| ---------------- |
|**Runtime** | ![](../../../../images/icons/runtime-topology-name.png?display=inline-block) the provisioned Runtime. <br>Hybrid Runtimes display the name of the K8s API server endpoint with the cluster. <br>Hosted Runtimes display 'Codefresh hosted'. |
|**Runtime** | ![](../../../../images/icons/runtime-topology-name.png?display=inline-block) the provisioned Runtime. <br>Hybrid Runtimes display the name of the K8s API server endpoint with the cluster. <!--- <br>Hosted Runtimes display 'Codefresh hosted'. --> |
|**Cluster** | The local, and managed clusters if any, for the Runtime. {::nomarkdown}<ul><li><img src="../../../../images/icons/runtime-topology-in-cluster.png" display=inline-block/> indicates the local cluster, always displayed as `in-cluster`. The in-cluster server URL is always set to `https://kubernetes.default.svc/`.</li><li><img src="../../../../images/icons/runtime-topology-managed-cluster.png" display=inline-block/> indicates a managed cluster.</li> <li> <img src="../../../../images/icons/runtime-topology-add-cluster.png" display=inline-block/> select to add a new managed cluster.</li></ul> {:/} To view cluster components, select the cluster. To add and work with managed clusters, see [Managing external clusters in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/). |
|**Health/Sync status** |The health and sync status of the Runtime or cluster. {::nomarkdown}<ul><li><img src="../../../../images/icons/error.png" display="inline-block"> indicates health or sync errors in the Runtime, or a managed cluster if one was added to the runtime.</br> The runtime or cluster node is bordered in red and the name is colored red.</li> <li><img src="../../../../images/icons/cf-sync-status.png" display=inline-block/> indicates that the Runtime is being synced to the cluster on which it is provisioned.</li></ul> {:/} |
|**Search and View options** | {::nomarkdown}<ul><li>Find a Runtime or its clusters by typing part of the Runtime/cluster name, and then navigate to the entries found. </li> <li>Topology view options: Resize to window, zoom in, zoom out, full screen view.</li></ul> {:/}|

## Designating Configuration Runtimes
Designate any GitOps Runtime, including the Hosted GitOps Runtime, as a Configuration Runtime to manage platform-level resources which are Runtime-agnostic. These resources are crucial for functionality related to Products in GitOps, and Promotions such as Promotion Policies, Promotion Templates, and Promotion Flows.
Designate any GitOps Runtime<!---, including the Hosted GitOps Runtime ,--> as a Configuration Runtime to manage platform-level resources which are Runtime-agnostic. These resources are crucial for functionality related to Products in GitOps, and Promotions such as Promotion Policies, Promotion Templates, and Promotion Flows.

##### Single vs multiple Configuration Runtimes
You can designate a single Runtime or multiple Runtimes as Configuration Runtimes. You may want to designate more than one Configuration Runtime for redundancy. Codefresh makes sure that there are no duplicate resources among the designated Configuration Runtimes if there are multiple such Runtimes.
Expand Down Expand Up @@ -593,7 +593,7 @@ Online logs show up to 1000 of the most recent events (lines), updated in real t
The file is downloaded as `<component-name>.log`.

## Reset Shared Configuration Repository for GitOps Runtimes
When you install the first Hybrid or Hosted GitOps Runtime for your account, as part of the setup, Codefresh creates the [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) in your Git provider account and validates the URL. The Shared Configuration Repo is used for all GitOps Runtimes you add to the same account.
When you install the first Hybrid <!--- or Hosted--> GitOps Runtime for your account, as part of the setup, Codefresh creates the [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) in your Git provider account and validates the URL. The Shared Configuration Repo is used for all GitOps Runtimes you add to the same account.

As a Codefresh admin, you can reset the repo defined for your account if the URL is either incorrect or missing, or if there are no active GitOps Runtimes. See [Reset Shared Configuration Repo]({{site.baseurl}}/docs/installation/gitops/shared-configuration/#reset-shared-configuration-repo).

Expand Down
Loading

0 comments on commit d4d3f6b

Please sign in to comment.