Skip to content

Commit 0ea2ca9

Browse files
committed
Update documentation
* Add upgrade how-to * Adjust parameters docs
1 parent cc23355 commit 0ea2ca9

File tree

3 files changed

+27
-2
lines changed

3 files changed

+27
-2
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
= Upgrade `component-argocd` from `v8.x` to `v9.x`
2+
3+
TIP: On clusters which use SSH to fetch the cluster catalogs no manual actions are necessary.
4+
5+
The component version `v9.x` defaults to ArgoCD v3 which only supports https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/#repositories[declarative configuration of repositories^].
6+
7+
The switch to declarative repository configuration is a breaking change for clusters which use HTTPS cluster catalogs.
8+
9+
Operators of such clusters must update the HTTPS credentials secret to be picked up as a repo credentials secret by ArgoCD v3:
10+
11+
[source,bash]
12+
----
13+
SECRET_NAME=the-credentials-secret <1>
14+
kubectl -n syn patch secret "$SECRET_NAME" --type=merge \
15+
-p '{"stringData":{"url":"'"$CATALOG_URL"'"}}'
16+
kubectl -n syn label secret "$SECRET_NAME" \
17+
argocd.argoproj.io/secret-type=repo-creds
18+
----
19+
<1> Replace with the name of the secret

docs/modules/ROOT/pages/references/parameters.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,16 @@ Override specs of the ProjectSyn ArgoCD instance.
128128
type:: string
129129
default:: `catalog-https-credentials`
130130

131-
The name of the externally managed secret which holds the username and password for fetching the catalog repo over HTTPS in fields `username` and `password`.
131+
The name of the externally managed secret which holds the username and password for fetching the catalog repo over HTTPS.
132+
133+
The secret must be labeled with `argocd.argoproj.io/secret-type=repo-creds`.
134+
The secret must have the credentials in fields `username` and `password` and must have the catalog repo HTTPS URL (or a prefix thereof) in field `url`.
135+
136+
NOTE: The `url` field must contain the catalog URL (or prefix) including the leading `https://`.
132137

133138
This parameter is only used when the cluster's catalog repo URL starts with `https://`.
134139

135-
IMPORTANT: Users must ensure that this secret is in place before this component is synced.
140+
IMPORTANT: Users must ensure that this secret is correctly configured and present before this component is synced.
136141

137142
== `images`
138143

docs/modules/ROOT/partials/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* xref:how-tos/upgrade-v3-v4.adoc[Upgrade from `v3.x` to `v4.x`]
55
* xref:how-tos/upgrade-v5-v6.adoc[Upgrade from `v5.5.x` to `v6.x`]
66
* xref:how-tos/upgrade-v7-v8.adoc[Upgrade from `v7.x` to `v8.x`]
7+
* xref:how-tos/upgrade-v8-v9.adoc[]
78
89
.References
910
* xref:references/parameters.adoc[Parameters]

0 commit comments

Comments
 (0)