Skip to content

Content qa #1251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 26 commits into from
Mar 30, 2025
Merged
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
1377654
Updates after review
NimRegev Mar 25, 2025
7c88d5f
Updates
NimRegev Mar 25, 2025
29e648c
Update gitops-apps-dashboard.md
NimRegev Mar 25, 2025
842e7cb
Update installation-options.md
NimRegev Mar 25, 2025
1fe0784
Update monitor-applications.md
NimRegev Mar 25, 2025
1dfdd6a
Update monitor-applications.md
NimRegev Mar 25, 2025
53318e1
Added conditions for user tokens
NimRegev Mar 25, 2025
12468af
Update manage-pats.md
NimRegev Mar 25, 2025
335dafe
Add symlink to values validation
NimRegev Mar 26, 2025
43f88ba
Update gitops-runtime.md
NimRegev Mar 26, 2025
25f8f1c
Update gitops-runtime.md
NimRegev Mar 26, 2025
d5174a3
Update ingress arch diagram
NimRegev Mar 26, 2025
5eacdbe
Update gitops.md
NimRegev Mar 26, 2025
8753c3a
Update paths for inline images with conditions
NimRegev Mar 27, 2025
88292cc
Updates
NimRegev Mar 27, 2025
b3670ad
Merge branch 'master' into content-qa
NimRegev Mar 27, 2025
6d68ae3
Fix endif tags
NimRegev Mar 27, 2025
69bba30
Merge branch 'content-qa' of https://github.com/codefresh-io/docs.cod…
NimRegev Mar 27, 2025
89773c0
Updates after self-review
NimRegev Mar 27, 2025
5557041
Updates
NimRegev Mar 27, 2025
a7945c0
Update monitor-applications.md
NimRegev Mar 27, 2025
4601811
Update monitor-applications.md
NimRegev Mar 27, 2025
4aa64e0
Update monitor-applications.md
NimRegev Mar 27, 2025
d7295e0
Merge branch 'master' into content-qa
NimRegev Mar 27, 2025
6f3fca0
Fix icon paths
NimRegev Mar 30, 2025
1cc852f
Update monitor-runtimes.md
NimRegev Mar 30, 2025
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 _docs/deployments/gitops/monitor-applications.md
Original file line number Diff line number Diff line change
@@ -355,7 +355,7 @@ The table describes the possible health statuses for an application resource in
{: .table .table-bordered .table-hover}
| Health icon | Health status | Description |
| -------------- | ------------| ------------------|
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-healthy.png" display=inline-block">{% endif %}{:/} {% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-healthy.png" display=inline-block">{% endif %}{:/} | **Healthy** | Resource is functioning as required. |
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-healthy.png" display=inline-block">{% endif %} {% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-healthy.png" display=inline-block"> {% endif %} {:/} | **Healthy** | Resource is functioning as required. |
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-progressing.png" display=inline-block">{:/} {% endif %} {% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-progressing.png" display=inline-block">{:/} {% endif %} | **Progressing** | Resource is not healthy but can become healthy before the timeout occurs. |
| {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-suspended.png" display=inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-suspended.png" display=inline-block">{% endif %}{:/} | **Suspended** | Resource is not functioning, and is either suspended or paused. For example, Cron job or a canary rollout.|
|{::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/current-state-missing.png" display=inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/current-state-missing.png" display=inline-block">{% endif %}{:/} | **Missing** | Resource is not present on the cluster. |
7 changes: 3 additions & 4 deletions _docs/installation/gitops/managed-cluster.md
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@ description: "Add multiple remote clusters to a GitOps Runtime and deploy applic
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/) 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.

@@ -15,7 +15,6 @@ 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/) -->
* Valid Git user 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
@@ -44,7 +43,7 @@ Optionally, to first generate the YAML manifests, and then manually apply them,
1. In the Codefresh UI, on the toolbar, click the **Settings** icon.
1. From Runtimes in the sidebar, select **GitOps Runtimes**.
1. From either the **Topology** or **List** views, select the Runtime to which to add the cluster.
1. Topology View: Select {::nomarkdown}<img src="../../../../images/icons/add-cluster.png" display=inline-block/>{:/}.
1. Topology View: Select {::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/add-cluster.png" display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/add-cluster.png" display=inline-block/>{% endif %}{:/}.
List View: Select the **Managed Clusters** tab, and then select **+ Add Cluster**.
1. In the Add Managed Cluster panel, if needed install the Codefresh GitOps CLI.
1. Copy and run the command:
@@ -128,7 +127,7 @@ View connection status for the managed cluster, and health and sync errors. Heal
Applications with `rollout` resources need Argo Rollouts on the target cluster, both to visualize rollouts in the Applications dashboard and control rollout steps with the Rollout Player.
If Argo Rollouts has not been installed on the target cluster, the **Install Argo Rollouts** button displayed.

Install Argo Rollouts with a single click to execute rollout instructions, deploy the application, and visualize rollout progress in the [Applications dashboard]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/).
Install Argo Rollouts with a single click to execute rollout instructions, deploy the application, and visualize rollout progress in the [GitOps Apps dashboard]({{site.baseurl}}/docs/dashboards/gitops-apps-dashboard/).


1. In the Codefresh UI, on the toolbar, click the **Settings** icon, and from Runtimes in the sidebar, select **GitOps Runtimes**.
8 changes: 4 additions & 4 deletions _docs/installation/gitops/monitor-runtimes.md
Original file line number Diff line number Diff line change
@@ -68,7 +68,7 @@ Here is a description of the information and options in the List View.
|**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 [Managing external clusters in GitOps 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]({{site.baseurl}}/docs/installation/gitops/manage-runtimes/#upgrade-gitops-runtimes)<br>[View changelogs for GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/manage-runtimes/#view-changelogs-for-gitops-runtimes)<br>[Rollback GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/manage-runtimes/#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.|
|**Sync Status**| The sync status of the GitOps Runtime. The sync status is displayed only when you have completed installation and configured the GitOps Runtime as an Argo CD Application. {::nomarkdown}<ul><li> {% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/runtime-synced.png" display=inline-block>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/runtime-synced.png" display=inline-block>{% endif %} <b>Synced</b></li> <li><img src="../../../../images/icons/runtime-syncing.png" display=inline-block> <b>Syncing</b>.</li><li><img src="../../../../images/icons/runtime-out-of-sync.png" display=inline-block> <b>Out-of-sync</b>.</li><li><b>N/A</b>: Codefresh could not get the sync status. This could be because the Runtime is not configured as an Argo CD Application.</li><li><b>Complete Installation</b>: Git credentials are not configured for the Runtime. Click the three-dot context menu and select <b>Update Git Runtime Credentials</b>. See <a href="https://codefresh.io/docs/docs/installation/gitops/manage-runtimes/#update-git-credentials-for-gitops-runtimes">Update Git credentials for GitOps Runtimes</a>.</li> </ul> {:/} |
|**Sync Status**| The sync status of the GitOps Runtime. The sync status is displayed only when you have completed installation and configured the GitOps Runtime as an Argo CD Application. {::nomarkdown}<ul><li> {% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/runtime-synced.png" display=inline-block>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/runtime-synced.png" display=inline-block>{% endif %} <b>Synced</b></li> <li>{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/runtime-syncing.png" display=inline-block>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/runtime-syncing.png" display=inline-block>{% endif %} <b>Syncing</b>.</li><li>{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/runtime-out-of-sync.png" display=inline-block>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/runtime-out-of-sync.png" display=inline-block>{% endif %} <b>Out-of-sync</b>.</li><li><b>N/A</b>: Codefresh could not get the sync status. This could be because the Runtime is not configured as an Argo CD Application.</li><li><b>Complete Installation</b>: Git credentials are not configured for the Runtime. Click the three-dot context menu and select <b>Update Git Runtime Credentials</b>. See <a href="https://codefresh.io/docs/docs/installation/gitops/manage-runtimes/#update-git-credentials-for-gitops-runtimes">Update Git credentials for GitOps Runtimes</a>.</li> </ul> {:/} |
|**Actions** | The possible actions to manage the selected runtime.{::nomarkdown}<ul><li> <b>Set as Configuration Runtime</b>: Designate the selected Runtime to store platform resources which are runtime-agnostic. See <a href="https://codefresh.io/docs/docs/installation/gitops/configuration-runtime">Designating Configuration Runtimes</a>.</li><li><b>Upgrade</b>: Upgrade to the latest version. See <a href="https://codefresh.io/docs/docs/installation/gitops/manage-runtimes/#upgrade-gitops-runtimes">Upgrade GitOps Runtimes</a>.</li><li><b>Download All Logs</b>:Download logs for the Runtime or for its components. See <a href="https://codefresh.io/docs/docs/installation/gitops/manage-runtimes/#viewdownload-logs-for-gitops-runtimes">View/download logs for GitOps Runtimes</a>.</li><li><b>Update Git Runtime Credentials</b>: Update Git token for Runtime. See <a href="https://codefresh.io/docs/docs/installation/gitops/manage-runtimes/#update-git-credentials-for-gitops-runtimes">Update Git credentials for GitOps Runtimes</a>.</li><li><b>Runtimes as applications</b>: Options to view and monitor GitOps Runtimes as applications in the Current State tab of the GitOps Apps dashboard. For details on monitoring appplication resources, see <a href="https://codefresh.io/docs/docs/deployments/gitops/applications-dashboard/#monitoring-resources-for-selected-argo-cd-application">Monitoring resources for Argo CD applications</a>.<ul><li><b>Runtime Application</b>: Available only when the GitOps Runtime is configured as an Argo CD application. For configuration steps, see <a href="https://codefresh.io/docs/docs/installation/gitops/manage-runtimes/#configure-runtime-as-argo-cd-application">Configuring GitOps Runtime as an Argo CD application</a>.</li><li><b>Runtime ISC Application</b>: Available when a Hybrid GitOps Runtime is installed. Displays the resources of the Shared Configuration Repository (referred to internally as <code class="highlighter-rouge">ISC/isc</code>).</li><li><b>Runtime Resources Application</b>: Available when a Hybrid GitOps Runtime is installed. Displays the resources in the local cluster (in-cluster).</li></ul></li><li><b>Delete Runtime</b>: Available only when the Hybrid GitOps Runtime is Offline. <br>Delete the GitOps Runtime from the Codefresh platform, retaining it on the cluster. See <a href="https://codefresh.io/docs/docs/installation/gitops/manage-runtimes/#delete-gitops-runtimes">Delete GitOps Runtimes</a>. </li><li><b>Uninstall Runtime</b>: Uninstall the runtime from the cluster on which it is provisioned. See <a href="https://codefresh.io/docs/docs/installation/gitops/manage-runtimes/#uninstall-gitops-runtimes">Uninstall GitOps Runtimes</a>.</li> </ul> {:/}|


@@ -92,9 +92,9 @@ Here is a description of the information and options 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'. --> |
|**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> {:/} |
|**Runtime** | !{::nomarkdown}{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/runtime-topology-name.png" display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/runtime-topology-name.png" display=inline-block/>{% endif %} 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>{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/runtime-topology-in-cluster.png" display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/runtime-topology-in-cluster.png" display=inline-block/>{% endif %}indicates the local cluster, always displayed as `in-cluster`. The in-cluster server URL is always set to `https://kubernetes.default.svc/`.</li><li>{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/runtime-topology-managed-cluster.png" display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/runtime-topology-managed-cluster.png" display=inline-block/>{% endif %} indicates a managed cluster.</li> <li>{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/runtime-topology-add-cluster.png" display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/runtime-topology-add-cluster.png" display=inline-block/>{% endif %} 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>{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/error.png" display="inline-block">{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/error.png" display="inline-block">{% endif %} 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>{% if page.collection != site.gitops_collection %}<img src="../../../../images/icons/cf-sync-status.png" display=inline-block/>{% endif %}{% if page.collection == site.gitops_collection %}<img src="../../../images/icons/cf-sync-status.png" display=inline-block/>{% endif %}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> {:/}|

## Related articles
4 changes: 2 additions & 2 deletions _docs/installation/gitops/runtime-concepts.md
Original file line number Diff line number Diff line change
@@ -48,7 +48,7 @@ When you install the first GitOps Runtime in your account, Codefresh automatical
During installation, you must specify the Git repository URL for the Shared Configuration Repository. You can specify just the repository URL or include additional details such as a specific branch and path.

Watch this video for an overview:
{::nomarkdown}<img src=../../../../images/icons/video-play-icon-blue.svg?display=inline-block>{:/} [Shared Configuration Repository](https://www.youtube.com/watch?v=7WNoNZ58IzU){:target="\_blank"}
{::nomarkdown}{% if page.collection != site.gitops_collection %}<img src=../../../../images/icons/video-play-icon-blue.svg?display=inline-block>{% endif %}{% if page.collection == site.gitops_collection %}<img src=../../../images/icons/video-play-icon-blue.svg?display=inline-block>{% endif %}{:/} [Shared Configuration Repository](https://www.youtube.com/watch?v=7WNoNZ58IzU){:target="\_blank"}

For detailed information, see [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/).

@@ -70,7 +70,7 @@ You can add a Git Source during Runtime installation or later as needed. A singl
Codefresh manages the Git Source itself as an Argo CD application.

Watch this video for an overview:
{::nomarkdown}<img src=../../../../images/icons/video-play-icon-blue.svg?display=inline-block>{:/} [Git Sources in Runtimes](https://www.youtube.com/watch?v=StKxdCcOIQc&t=2s){:target="\_blank"}
{::nomarkdown}{% if page.collection != site.gitops_collection %}<img src=../../../../images/icons/video-play-icon-blue.svg?display=inline-block>{% endif %}{% if page.collection == site.gitops_collection %}<img src=../../../images/icons/video-play-icon-blue.svg?display=inline-block>{% endif %}{:/} [Git Sources in Runtimes](https://www.youtube.com/watch?v=StKxdCcOIQc&t=2s){:target="\_blank"}

For detailed information, see [Managing Git Sources in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/).

3 changes: 2 additions & 1 deletion _docs/installation/gitops/shared-configuration.md
Original file line number Diff line number Diff line change
@@ -8,7 +8,8 @@ toc: true
A Codefresh account with a GitOps Runtime can store configuration manifests for account-level resources in a Git repository. This repository, the Shared Configuration Repository, can be shared with other GitOps Runtimes in the same account, avoiding the need to create and maintain different configuration manifests for every GitOps Runtime. At the same time, you also have the flexibility to store resources unique to specific Runtimes without affecting other Runtimes.

Watch this video for an overview:
{::nomarkdown}<img src=../../../../images/icons/video-play-icon-blue.svg?display=inline-block>{:/} [Shared Configuration Repository](https://www.youtube.com/watch?v=7WNoNZ58IzU){:target="\_blank"}

{::nomarkdown}{% if page.collection != site.gitops_collection %}<img src=../../../../images/icons/video-play-icon-blue.svg?display=inline-block>{% endif %}{% if page.collection == site.gitops_collection %}<img src=../../../images/icons/video-play-icon-blue.svg?display=inline-block>{% endif %}{:/} [Shared Configuration Repository](https://www.youtube.com/watch?v=7WNoNZ58IzU){:target="\_blank"}