Skip to content

Commit 20ae485

Browse files
NimRegevNimRegev
authored
Add changelog section (#982)
* Add changelog section * Update monitor-manage-runtimes.md * Update monitor-manage-runtimes.md * Update monitor-manage-runtimes.md * Update monitor-manage-runtimes.md * Add changelog access in artifacthub Added details to access changelog for runtimes in ArtifactHub * Update hybrid-gitops-helm-installation.md Updated K8s to v1.29 and added Helm version requirement as 3.8.0 * Update rollback and sys requirements Aligned K8s requirements with ArtifactHub and added Helm version * Update monitor-manage-runtimes.md
1 parent e9ed8e8 commit 20ae485

File tree

4 files changed

+93
-23
lines changed

4 files changed

+93
-23
lines changed

‎_docs/installation/gitops/hybrid-gitops-helm-installation.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -945,7 +945,8 @@ You can [monitor]({{site.baseurl}}/docs/deployments/gitops/applications-dashboar
945945
{: .table .table-bordered .table-hover}
946946
| Item | Requirement |
947947
| -------------- | -------------- |
948-
|Kubernetes cluster | Server version 1.21 to 1.27, _without_ Argo Project components. {::nomarkdown}<br><b>Tip</b>: To check the server version, run:<br> <code class="highlighter-rouge">kubectl version --short</code>.{:/}|
948+
|Kubernetes cluster | Server version 1.23 or higher {::nomarkdown}<br><b>Tip</b>: To check the server version, run:<br> <code class="highlighter-rouge">kubectl version --short</code>{:/}|
949+
|Helm| 3.8.0 or higher|
949950
|Node requirements| {::nomarkdown}<ul><li>Memory: 5000 MB</li><li>CPU: 2</li></ul>{:/}|
950951
|Cluster permissions | Cluster admin permissions |
951952
|Git providers |{::nomarkdown}<ul><li>GitHub</li><li>GitHub Enterprise</li><li>GitLab Cloud</li><li>GitLab Server</li><li>Bitbucket Cloud</li><li>Bitbucket Server</li></ul>{:/}|

‎_docs/installation/gitops/monitor-manage-runtimes.md

Lines changed: 91 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ toc: true
1010
---
1111

1212

13-
The **Runtimes** page displays the provisioned GitOps Runtimes in your account, both Hybrid, and the Hosted Runtime if you have one.
13+
The **Runtimes** page displays the provisioned GitOps Runtimes in your account, both Hybrid Runtimes, and the Hosted Runtime if you have one.
1414

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

1717
{% include
1818
image.html
@@ -32,8 +32,8 @@ Unless specified otherwise, all options are common to both types of GitOps Runti
3232

3333
{{site.data.callout.callout_warning}}
3434
**WARNING**
35-
Do not change the ArgoCD password by logging into the ArgoCD UI with the `argocd-initial-admin-secret`.
36-
Changing the ArgoCD password can result in system instability, and disrupt the proper functioning of the Codefresh platform.
35+
Do not change the Argo CD password by logging into the Argo CD UI with the `argocd-initial-admin-secret`.
36+
Changing the Argo CD password can result in system instability, and disrupt the proper functioning of the Codefresh platform.
3737
{{site.data.callout.end}}
3838

3939

@@ -70,7 +70,7 @@ Here is a description of the information in the List View.
7070
|**Cluster/Namespace**| The K8s API server endpoint, as well as the namespace with the cluster. |
7171
|**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. |
7272
|**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/).|
73-
|**Version**| The version of the Runtime currently installed (CLI installations), including the version of the Helm chart (Helm installations) . **Update Available!** indicates there are newer versions of the Runtime or Helm chart. To see all the commits, mouse over **Update Available!**, and select **View Complete Change Log**.
73+
|**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) |
7474
|**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.|
7575
|**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 Application. {::nomarkdown}<ul><li> <img src="../../../../images/icons/runtime-synced.png" display=inline-block> <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 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/monitor-manage-runtimes/#update-git-credentials-for-gitops-runtimes">Update Git credentials for GitOps Runtimes</a>.</li> </ul> {:/} |
7676
|**Actions** | The possible actions to manage the selected runtime.{::nomarkdown}<ul><li> <b>Upgrade</b>: Upgrade to the latest version. See <a href="https://codefresh.io/docs/docs/installation/gitops/monitor-manage-runtimes/#hybrid-gitops-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/monitor-manage-runtimes/#viewdownload-logs-to-troubleshoot-gitops-runtimes">View/download logs for GitOps Runtimes</a></li><li><b>Update Git Runtime Credentials</b>: Update Git token for Runtime. See </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/monitor-manage-runtimes/#hybrid-gitops-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/monitor-manage-runtimes/#uninstall-gitops-runtimes">Uninstall GitOps Runtimes</a></li> </ul> {:/}|
@@ -102,23 +102,29 @@ Here is a description of the information in the Topology view.
102102

103103
## (Hybrid GitOps) Upgrade GitOps Runtimes
104104

105-
Upgrade provisioned Hybrid GitOps Runtimes to install critical security updates, get new functionality, and the latest versions of all components.
106-
The upgrade procedure differs depending on whether the GitOps Runtime has been configured as an Argo CD application or not:
107-
* Argo CD GitOps Runtimes: For Runtimes configured as Argo CD applications, you need to manually update the version in the Helm chart located in the Shared Configuration Repository.
108-
* Non-Argo CD GitOps Runtimes: Run the upgrade command.
105+
Upgrade provisioned Hybrid GitOps Runtimes to install critical security updates, new functionality, and the latest versions of all components.
109106

110-
If you have managed clusters for Hybrid GitOps Runtimes, upgrading the Runtime automatically updates runtime components within the managed cluster as well.
107+
**Changelog for new versions**
108+
Codefresh alerts you to newer versions of Runtimes, through `Update Available! Notification` in the List View's Version column. A new version of the GtiOps Runtime includes a link to the changelog, detailing the changes in that version.
109+
See also [View changelogs for GitOps Runtimes](#changelog-for-all-runtime-releases).
110+
111+
**Upgrade procedure**
112+
The upgrade procedure differs slightly depending on whether the GitOps Runtime has been configured as an Argo CD application or not:<br>
113+
* Argo CD GitOps Runtimes
114+
For Runtimes configured as Argo CD applications, you need to manually update the version in the Helm chart located in the Shared Configuration Repository.
115+
* Non-Argo CD GitOps Runtimes
116+
Run the upgrade command.
111117

112118
{{site.data.callout.callout_tip}}
113119
**TIP**
114-
The `Update Available! Notification` in the List View's Version column indicates that a newer version of the Runtime, Helm chart, or both are available.
120+
If you have managed clusters for Hybrid GitOps Runtimes, upgrading the Runtime automatically updates runtime components within the managed cluster as well.
115121
{{site.data.callout.end}}
116122

123+
##### How to
117124
1. In the Codefresh UI, on the toolbar, click the **Settings** icon.
118-
1. From Runtimes in the sidebar, select [**GitOps Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
119-
1. Switch to either the **List View** or to the **Topology View**.
120-
1. **List view**:
121-
1. To see all the commits to the Runtime, in the Version column, mouse over **Update Available!**, and select **View Complete Change Log**.
125+
1. From Runtimes in the sidebar, select [**GitOps Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}, and then switch to either **List View** or to the **Topology View**.
126+
1. To upgrade in **List view**, move to the **Version** column, and do the following:
127+
1. To see the changes in the new version of the Runtime, mouse over **Update Available!**, and click **View Complete Change Log**.
122128
1. Do one of the following:
123129
* To the right of the row with the Runtime to upgrade, click the context menu and select **Upgrade**.
124130
* Click the Runtime name, and then click **Upgrade** on the top-right.
@@ -133,7 +139,8 @@ The `Update Available! Notification` in the List View's Version column indicates
133139
max-width="80%"
134140
%}
135141

136-
**Topology view**:
142+
{:start="4"}
143+
1. To upgrade in **Topology view**:
137144
Click the Runtime cluster, and from the panel, click the context menu, and then select **Upgrade Runtime**.
138145
{% include
139146
image.html
@@ -147,12 +154,13 @@ The `Update Available! Notification` in the List View's Version column indicates
147154

148155
{:start="5"}
149156
1. Do one of the following depending on whether you have configured the Runtime as an Argo CD Application or not:
150-
* Argo CDGitOps Runtimes:Continue from step _6_.
151-
* Non-Argo CD GitOps Runtimes: Continue from step _7_.
157+
* Argo CD GitOps Runtimes: Continue from _step 6_.
158+
* Non-Argo CD GitOps Runtimes: Continue from _step 7_.
152159
1. For GitOps Runtimes, do the following:
153-
1. In your Shared Configuration Repository, go to `resources/<runtime_name>/chart`
154-
where, `<runtime_name>` is the name of the Hybrid GitOps Runtime to upgrade.
155-
1. In the `chart.yaml`, change the version number in both `.version` and `.dependencies.version`.
160+
1. In your Shared Configuration Repository, go to `resources/<runtime_name>/chart`
161+
where:
162+
`<runtime_name>` is the name of the Hybrid GitOps Runtime to upgrade.
163+
1. In `chart.yaml`, change the version number in both `.version` and `.dependencies.version`.
156164
1. Commit the change, and push to your Git server.
157165
```yaml
158166
apiVersion: v2
@@ -166,10 +174,71 @@ dependencies:
166174
version: <version>
167175
```
168176
1. For non-GitOps Runtimes, do the following:
169-
1. Copy and run the upgrade command:
177+
1. Copy and run the upgrade command:
170178
`RELEASE_NAME=$(helm ls -n codefresh-gitops-runtime -q) && helm upgrade ${RELEASE_NAME} -n codefresh-gitops-runtime`
171179
1. To exit the upgrade panel, click **Close**.
172180

181+
## (Hybrid GitOps) View changelogs for GitOps Runtimes
182+
Each version of a GitOps Runtime includes a changelog detailing the changes in that release.
183+
Changelogs are available in ArtifactHub and GitHub
184+
185+
##### Changelog for latest Runtime release in Codefresh
186+
In the GitOps Runtimes List view, the Version column displays the version currently installed.
187+
188+
Whenever there is a newer version of the Runtime, Helm chart, or both, the **Update Available!** notification appears in the same column.
189+
Mouse over shows a link to the changelog for that version on GitHub.
190+
The example below shows the changelog for the **Latest** release of the GitOps Runtime.
191+
192+
{% include
193+
image.html
194+
lightbox="true"
195+
file="/images/runtime/helm/runtime-changelog.png"
196+
url="/images/runtime/helm/runtime-changelog.png"
197+
alt="Example of changelog for GitOps Runtime on GitHub"
198+
caption="Example of changelog for GitOps Runtime on GitHub"
199+
max-width="60%"
200+
%}
201+
202+
203+
##### Changelogs for all Runtime releases
204+
Changelogs for all versions, including historical versions, are available on ArtifactHub and GitHub.
205+
206+
* [GitHub](https://github.com/codefresh-io/gitops-runtime-helm/releases){:target="\_blank"}
207+
* [ArtifactHub](https://artifacthub.io/packages/helm/codefresh-gitops-runtime/gitops-runtime#prerequisites)
208+
On the right, select the chart version, and then click **Changelog** above.
209+
210+
{% include
211+
image.html
212+
lightbox="true"
213+
file="/images/runtime/helm/runtime-changelog-artifacthub.png"
214+
url="/images/runtime/helm/runtime-changelog-artifacthub.png"
215+
alt="Accessing changelog for GitOps Runtime on ArtifactHub"
216+
caption="Accessing changelog for GitOps Runtime on ArtifactHub"
217+
max-width="50%"
218+
%}
219+
220+
## (Hybrid GitOps) Roll back GitOps Runtimes
221+
After upgrading a GitOps Runtime, roll back to the previous or a specific version of the Runtime.
222+
223+
The rollback procedure differs slightly depending on whether the GitOps Runtime has been configured as an Argo CD application or not.
224+
225+
##### Argo CD GitOps Runtimes
226+
Manually change the version in the Helm chart (`chart.yaml`) located in the Shared Configuration Repository.
227+
228+
1. In your Shared Configuration Repository, go to:
229+
`resources/<runtime_name>/chart`
230+
where:
231+
`<runtime_name>` is the name of the Hybrid GitOps Runtime to upgrade.
232+
1. In `chart.yaml`, change the version number in both `.version` and `.dependencies.version`.
233+
1. Commit the change, and push to your Git server.
234+
235+
##### Non-Argo CD GitOps Runtimes
236+
Use Helm commands such as `rollback` or `upgrade`.
237+
238+
If you need details, see the documentation on [Helm commands](https://helm.sh/docs/helm/helm_init/){:target="\_blank"}.
239+
240+
241+
173242
## Update Git credentials for GitOps Runtimes
174243

175244
Provisioned GitOps Runtimes require valid Git Runtime tokens at all times to authenticate and authorize the Runtime.

‎images/runtime/helm/runtime-changelog-artifacthub.png

194 KB
Loading

‎images/runtime/helm/runtime-changelog.png

136 KB
Loading

0 commit comments

Comments
 (0)