Skip to content

Commit 422a225

Browse files
danielfbmdanielfbm
committed
📚 Sync docs from alaudadevops/connectors-operator on 9c73257329f2273a96bbb0ebb14e1cbaf13596b4
Source: chore: Restructuring and adding more detailed docs for upgrades (#122) Author: Daniel Filipe Bruehmueller Morinigo Ref: refs/heads/main Commit: 9c73257329f2273a96bbb0ebb14e1cbaf13596b4 This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: AlaudaDevops/connectors-operator@9c73257 🤖 Synced on 2025-07-17 06:51:26 UTC
1 parent 2c25a03 commit 422a225

File tree

7 files changed

+1906
-1135
lines changed

7 files changed

+1906
-1135
lines changed

‎.github/SYNC_INFO.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Documentation Sync Information
22

3-
- **Last synced**: 2025-07-11 10:23:44 UTC
3+
- **Last synced**: 2025-07-17 06:51:26 UTC
44
- **Source repository**: alaudadevops/connectors-operator
5-
- **Source commit**: [68a82bc175e642ec1895c9ca50f0c1c6915831db](https://github.com/alaudadevops/connectors-operator/commit/68a82bc175e642ec1895c9ca50f0c1c6915831db)
6-
- **Triggered by**: kycheng
7-
- **Workflow run**: [#6](https://github.com/alaudadevops/connectors-operator/actions/runs/16217760440)
5+
- **Source commit**: [9c73257329f2273a96bbb0ebb14e1cbaf13596b4](https://github.com/alaudadevops/connectors-operator/commit/9c73257329f2273a96bbb0ebb14e1cbaf13596b4)
6+
- **Triggered by**: danielfbm
7+
- **Workflow run**: [#7](https://github.com/alaudadevops/connectors-operator/actions/runs/16338262751)
88

99
## Files synced:
1010
- docs/

‎docs/en/upgrade/index.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
weight: 20
3+
---
4+
5+
# Upgrade
6+
7+
<Overview />

docs/en/upgrade/01_upgrade.mdx renamed to docs/en/upgrade/upgrade-path.mdx

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Upgrading Connectors
3-
weight: 20
2+
title: Upgrade Path
3+
weight: 25
44
---
55

66
Upgrading Connectors is a relatively straightforward process, but the complexity can increase based on:
@@ -20,8 +20,3 @@ When performing an upgrade, you should always use the most recent patch version
2020
The latest patch versions for each release can be found in the [Release Notes](../overview/release_notes.mdx).
2121
:::
2222

23-
## Upgrade Steps
24-
25-
To upgrade Connectors components, you only need to upgrade the Operator version. The Connectors components will be upgraded automatically.
26-
27-
When upgrading, you need to upgrade the <ExternalSiteLink name="acp" href="extend/operator.html#upgrading-operators" children="Operator" /> version.

‎docs/en/upgrade/upgrade.mdx‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
title: Upgrading `Alauda DevOps Connectors` Operator
3+
weight: 35
4+
---
5+
6+
7+
# Upgrading `Alauda DevOps Connectors` Operator
8+
9+
10+
This document provides instructions for upgrading the `Alauda DevOps Connectors` Operator to a newer version using the `Marketplace`/`OperatorHub` interface in your cluster. The upgrade process is designed to be straightforward while ensuring minimal disruption to existing resources.
11+
12+
## Upgrade Overview
13+
14+
Upgrading the `Alauda DevOps Connectors` Operator allows you to access new features, bug fixes, and improvements to its components. The `Alauda DevOps Connectors` Operator handles the upgrade of all components according to your configuration.
15+
16+
## Before You Begin
17+
18+
Before upgrading the `Alauda DevOps Connectors` Operator, ensure you:
19+
20+
- Have administrative access to your cluster
21+
- Review the release notes for the new version to understand any breaking changes
22+
- Verify that your existing Connector components configurations are compatible with the new version
23+
- Confirm that all current components are in a ready state
24+
25+
## Upgrade Process
26+
27+
### Using `Marketplace`/`OperatorHub`
28+
29+
1. **Access the `Marketplace`/`OperatorHub`**
30+
- Log in to your cluster's management console
31+
- Navigate to the `Marketplace` or `OperatorHub` section
32+
33+
2. **Locate the `Alauda DevOps Connectors` Operator**
34+
- Search for `Alauda DevOps Connectors` in the search bar
35+
- Click on the `Alauda DevOps Connectors` card
36+
37+
3. **View Available Versions**
38+
- On the `Alauda DevOps Connectors` Operator details page, you'll see information about the currently installed version
39+
- The interface will indicate if a newer version is available
40+
- You can click different `Channels` to view all available versions
41+
42+
4. **Initiate the Upgrade**
43+
- If the target version is in a different `Channel`, switch to the corresponding `Channel` in the `Subscription` first
44+
- If the current `Channel` has a newer version available, you will see a prompt:
45+
- **New Version Detected**
46+
- To upgrade only the current Operator, click `Confirm` to upgrade.
47+
48+
5. **Configure Upgrade Settings (if applicable)**
49+
- Some upgrades may present configuration options
50+
- In most cases, the default settings will preserve your existing configuration
51+
52+
6. **Confirm and Start the Upgrade**
53+
- Click `Confirm` to begin the process
54+
- Review the upgrade details and confirm your selection
55+
- The system will update the `Alauda DevOps Connectors` Operator while maintaining your custom resources
56+
57+
7. **Monitor the Upgrade**
58+
- The upgrade progress will be displayed in the `OperatorHub` interface
59+
- You can also check the status in the `connectors-operator` namespace:
60+
```bash
61+
$ kubectl get pods -n connectors-operator
62+
```
63+
When all pods are in `Running` state, the operator upgrade is complete.
64+
The operator will then automatically upgrade components such as `ConnectorCore`, `ConnectorsGit`, `ConnetorsOCI`, etc.
65+
- Check the components upgrade status:
66+
```bash
67+
$ kubectl get installmanifest -n connectors-operator
68+
$ kubectl get pods -n connectors-operator
69+
```
70+
When all components and pods are in `Ready` state, the components upgrade is complete.
71+
72+
8. **Verify the Upgrade**
73+
- Check that the `Alauda DevOps Connnectors` Operator version has been updated:
74+
```bash
75+
$ kubectl get csv -n connectors-operator
76+
77+
NAME DISPLAY VERSION REPLACES PHASE
78+
connectors-operator.v1.y.z Alauda DevOps Connectors 1.y.z connectors-operator.v1.y.z Succeeded
79+
```
80+
When the `VERSION` matches the new version, the upgrade is complete.
81+
- Verify that all Connector components are functioning correctly
82+
83+
84+
## Post-Upgrade Steps
85+
86+
After the upgrade completes successfully:
87+
88+
1. **Verify Component Status**
89+
- Check that all Connectors components have been updated:
90+
```bash
91+
kubectl get connectorscore,connectorsgit,connectorsoci -A
92+
```
93+
94+
2. **Test Functionality**
95+
- Run a job using connector csi or deploy an app pulling the image through oci connector to verify that the system is working correctly
96+
- Ensure that all existing integrations continue to function
97+
98+
3. **Update Custom Resources if Needed**
99+
- If the new version introduces changes to CRDs, you may need to update your custom resources
100+
- Refer to the release notes for specific migration steps
101+
102+
## Rollback Procedure
103+
104+
If you encounter issues with the new version, you can roll back to the previous version:
105+
106+
1. Return to the `Marketplace`/`OperatorHub` interface
107+
2. Select the `Alauda DevOps Connectors` Operator
108+
3. `Uninstall` the current version
109+
4. Choose the previous version from the version list
110+
5. Follow the installation process for that version
111+
112+
:::note
113+
Downgrading may require additional steps to ensure compatibility of your resources with the older version.
114+
115+
This depends on the differences between the version you upgraded from and the version you upgraded to. If the differences are large, you may need to manually migrate resources.
116+
:::
117+
118+
119+
## Troubleshooting
120+
121+
If you encounter issues during or after the upgrade:
122+
123+
- Check the `Alauda DevOps Connectors` Operator pod logs:
124+
```bash
125+
$ kubectl logs -l control-plane=connectors-operator -n connectors-operator
126+
```
127+
128+
- Verify the status of Connector resource, i.e. ConnectorCore:
129+
```bash
130+
$ kubectl get connectorscore -A
131+
# Find the instance with issue
132+
$ kubectl get connectorscore -n <namespace> <instance name> -o yaml
133+
```
134+
135+
## Next Steps
136+
137+
After successfully upgrading the `Alauda DevOps Connectors` Operator:
138+
139+
- Explore new features introduced in the latest version
140+
- Consider enabling additional components that may be available in the new version

‎docs/public/logo.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"devDependencies": {
3-
"@alauda/doom": "^1.2.0",
3+
"@alauda/doom": "^1.10.2",
44
"typescript": "^5.7.3"
55
},
66
"scripts": {

0 commit comments

Comments
 (0)