Skip to content

Commit 3853d47

Browse files
Oleksandr123234Oleksandr123234
committed
docs: Update upgrade krci to 3-12 guide (#526)
1 parent 5353bc7 commit 3853d47

3 files changed

Lines changed: 49 additions & 30 deletions

File tree

‎cspell.config.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ words:
3131
- boltdb
3232
- Bridgecrew
3333
- buildtool
34+
- buildkit
3435
- cacerts
3536
- cbis
3637
- cbtype

‎docs/operator-guide/upgrade/upgrade-krci-3.12.md‎

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,25 @@ We suggest backing up the KubeRocketCI environment before starting the upgrade p
2424
In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated](https://github.com/epam/edp-tekton/issues/511) and replaced with `ghcr.io/kuberocketci/krci-cache`. In case of using the [tekton-cache](https://github.com/epam/edp-tekton/tree/master/charts/tekton-cache) Helm chart, the image will be automatically updated during the upgrade process.
2525
:::
2626

27-
1. (Optional) Update Tekton Custom Pipelines
27+
:::warning
28+
Since Kaniko Docker image build tool support has been discontinued, the [BuildKit](https://docs.docker.com/build/buildkit/) tool support has been introduced. Users now have a choice between two image build tools: Kaniko and BuildKit. For this reason, the `dockerbuild-verify` and `kaniko-build` Tekton Tasks no longer exist. Rename these Tasks by the following pattern if you leverage them in your custom pipelines:
29+
30+
- `dockerbuild-verify` → `dockerbuild-verify-kaniko` or `dockerbuild-verify-buildkit`, depending on which build tool you are using.
31+
32+
- `kaniko-build` → `container-build` (this task works with both Kaniko and BuildKit tools).
33+
34+
Kaniko is still used by default. To switch between Kaniko and BuildKit, set the `tekton.containerBuildTool` parameter in the [pipelines-library values](https://github.com/epam/edp-tekton/blob/master/charts/pipelines-library/values.yaml#L230).
35+
:::
36+
37+
1. (Optional) Update custom Tekton Pipelines:
2838

2939
:::note
3040
For more information about using Tekton custom pipelines in KubeRocketCI, refer to the [Create and Use Custom Tekton Pipelines](../../use-cases/custom-pipelines-flow.md) use case.
3141
:::
3242

3343
In case of using Tekton custom pipelines, it is necessary to update them to ensure compatibility with the new version of KubeRocketCI.
3444

35-
1. Branch Name Validation Update
45+
1. Update branch name validation:
3646

3747
Starting from version 3.12, the KubeRocketCI portal [supports](https://github.com/epam/edp-headlamp/issues/753) adding branches with long names (more than 30 characters), including support for special characters and uppercase letters. Due to this change, it is necessary to update the passing parameters for the `update-cbis` task in the Tekton custom build pipelines to ensure compatibility with the new version of KubeRocketCI.
3848

@@ -159,7 +169,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
159169
```
160170
</details>
161171

162-
2. Build Pipeline Task Condition Update
172+
2. Build Pipeline Task Condition Update:
163173

164174
:::note
165175
This change is relevant only for build pipelines with `semver` versioning type.
@@ -236,7 +246,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
236246
</TabItem>
237247
</Tabs>
238248

239-
3. Deploy Pipeline Parameters Renaming
249+
3. Deploy Pipeline Parameters Renaming:
240250

241251
:::note
242252
For detailed information about parameter changes in Tekton tasks, refer to the [edp-tekton](https://github.com/epam/edp-tekton/tree/master/charts/pipelines-library/templates/tasks) repository.
@@ -424,7 +434,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
424434
</TabItem>
425435
</Tabs>
426436

427-
2. (Optional) Enable Repository Discovery
437+
3. (Optional) Enable Repository Discovery:
428438

429439
:::warning
430440
In case of using GitFusion with the Bitbucket Git provider, it is necessary to update the Bitbucket API token permissions to include the `read:account` scope. For more details on how to create a Bitbucket app password with the required permissions, refer to the [Add Git Server](../../user-guide/add-git-server.md) guide.
@@ -449,7 +459,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
449459
enabled: true
450460
```
451461

452-
2. Update the KrakenD configuration to include the GitFusion API endpoints.
462+
2. Update the KrakenD configuration to include the GitFusion API endpoints:
453463

454464
:::note
455465
The latest KrakenD configuration can be found in the [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/krakend) repository.
@@ -798,7 +808,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
798808
```
799809
</details>
800810

801-
3. Update the KrakenD secret with the GitFusion URL variable.
811+
3. Update the KrakenD secret with the GitFusion URL variable:
802812

803813
:::note
804814
The `GITFUSION_URL` variable should point to the GitFusion service URL, e.g., `http://gitfusion.krci:8080`.
@@ -841,7 +851,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
841851

842852
![GitFusion](../../assets/operator-guide/upgrade/gitfusion.png)
843853

844-
3. (Optional) Align Remote Cluster Names
854+
4. (Optional) Align Remote Cluster Names:
845855

846856
In case of using remote clusters in KubeRocketCI, it is necessary to update the remote cluster names in KubeRocketCI portal after upgrading to version 3.12.
847857

@@ -851,37 +861,37 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
851861

852862
There are two ways to align the remote cluster names in the KubeRocketCI portal:
853863

854-
1. Recreate the remote cluster integration in the KubeRocketCI portal.
864+
1. Recreate the remote cluster integration in the KubeRocketCI portal:
855865

856866
1. Navigate to the **Configuration** -> **Deployment** -> **Clusters** section in the KubeRocketCI portal.
857867

858-
2. Click on the cluster integration that needs to be updated and delete it by clicking the **Delete** (trash can) icon.
868+
2. Click on the cluster integration that needs to be updated and delete it by clicking the **Delete** (trash can) icon:
859869

860870
![Delete Cluster](../../assets/operator-guide/upgrade/delete-cluster.png)
861871

862872
Confirm the deletion in the pop-up window.
863873

864-
3. After the cluster integration is deleted, click the **Add Cluster** button to create a new cluster integration. Fill in the required fields and click the **Save** button to add the cluster.
874+
3. After the cluster integration is deleted, click the **Add Cluster** button to create a new cluster integration. Fill in the required fields and click the **Save** button to add the cluster:
865875

866876
![Add Cluster](../../assets/operator-guide/upgrade/add-cluster.png)
867877

868878
After the new cluster integration is created, the correct cluster name will be displayed in the KubeRocketCI portal.
869879

870-
2. Update the `kubeconfig` specification in the `<cluster-name>` Kubernetes secret.
880+
2. Update the `kubeconfig` specification in the `<cluster-name>` Kubernetes secret:
871881

872882
:::note
873883
The `<cluster-name>` secret is created automatically when a new cluster integration is added in the KubeRocketCI portal. The secret contains the `kubeconfig` specification used to connect to the remote cluster.
874884
:::
875885

876886
It is also possible to update the `kubeconfig` specification in the existing `<cluster-name>` secret to change the cluster name, instead of recreating the cluster integration in the KubeRocketCI portal.
877887

878-
1. Locate the `<cluster-name>` secret in the namespace where KubeRocketCI is installed (e.g., `krci` namespace).
888+
1. Locate the `<cluster-name>` secret in the namespace where KubeRocketCI is installed (e.g., `krci` namespace):
879889

880890
```bash
881891
kubectl get secret <cluster-name> -n krci -o yaml
882892
```
883893

884-
2. Update the `kubeconfig` specification by changing the `clusters.name` and `contexts.context.cluster` fields to match the desired cluster name.
894+
2. Update the `kubeconfig` specification by changing the `clusters.name` and `contexts.context.cluster` fields to match the desired cluster name:
885895

886896
:::note
887897
The `data.config` field in the secret is base64 encoded. To update the `kubeconfig` specification, decode the `data.config` field, make the necessary changes, and then encode it back to base64 before updating the secret.
@@ -926,7 +936,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
926936

927937
After updating the `kubeconfig` specification in the secret, the correct cluster name will be displayed in the KubeRocketCI portal.
928938

929-
4. To upgrade KubeRocketCI to the v3.12, run the following commands:
939+
5. To upgrade KubeRocketCI to the v3.12, run the following commands:
930940

931941
:::note
932942
To verify the installation, it is possible to test the deployment before applying it to the cluster with the `--dry-run` key:

‎versioned_docs/version-3.12/operator-guide/upgrade/upgrade-krci-3.12.md‎

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,23 @@ We suggest backing up the KubeRocketCI environment before starting the upgrade p
2424
In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated](https://github.com/epam/edp-tekton/issues/511) and replaced with `ghcr.io/kuberocketci/krci-cache`. In case of using the [tekton-cache](https://github.com/epam/edp-tekton/tree/master/charts/tekton-cache) Helm chart, the image will be automatically updated during the upgrade process.
2525
:::
2626

27-
1. (Optional) Update Tekton Custom Pipelines
27+
:::warning
28+
Since Kaniko Docker image build tool support has been discontinued, the [BuildKit](https://docs.docker.com/build/buildkit/) tool support has been introduced. Users now have a choice between two image build tools: Kaniko and BuildKit. For this reason, the `dockerbuild-verify` and `kaniko-build` Tekton Tasks no longer exist. Rename these Tasks by the following pattern if you leverage them in your custom pipelines:
29+
30+
- `dockerbuild-verify` → `dockerbuild-verify-kaniko` or `dockerbuild-verify-buildkit`, depending on which build tool you are using.
31+
32+
- `kaniko-build` → `container-build` (this task works with both Kaniko and BuildKit tools).
33+
:::
34+
35+
1. (Optional) Update custom Tekton Pipelines:
2836

2937
:::note
3038
For more information about using Tekton custom pipelines in KubeRocketCI, refer to the [Create and Use Custom Tekton Pipelines](../../use-cases/custom-pipelines-flow.md) use case.
3139
:::
3240

3341
In case of using Tekton custom pipelines, it is necessary to update them to ensure compatibility with the new version of KubeRocketCI.
3442

35-
1. Branch Name Validation Update
43+
1. Update branch name validation:
3644

3745
Starting from version 3.12, the KubeRocketCI portal [supports](https://github.com/epam/edp-headlamp/issues/753) adding branches with long names (more than 30 characters), including support for special characters and uppercase letters. Due to this change, it is necessary to update the passing parameters for the `update-cbis` task in the Tekton custom build pipelines to ensure compatibility with the new version of KubeRocketCI.
3846

@@ -159,7 +167,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
159167
```
160168
</details>
161169

162-
2. Build Pipeline Task Condition Update
170+
2. Build Pipeline Task Condition Update:
163171

164172
:::note
165173
This change is relevant only for build pipelines with `semver` versioning type.
@@ -236,7 +244,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
236244
</TabItem>
237245
</Tabs>
238246

239-
3. Deploy Pipeline Parameters Renaming
247+
3. Deploy Pipeline Parameters Renaming:
240248

241249
:::note
242250
For detailed information about parameter changes in Tekton tasks, refer to the [edp-tekton](https://github.com/epam/edp-tekton/tree/master/charts/pipelines-library/templates/tasks) repository.
@@ -424,7 +432,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
424432
</TabItem>
425433
</Tabs>
426434

427-
2. (Optional) Enable Repository Discovery
435+
3. (Optional) Enable Repository Discovery:
428436

429437
:::warning
430438
In case of using GitFusion with the Bitbucket Git provider, it is necessary to update the Bitbucket API token permissions to include the `read:account` scope. For more details on how to create a Bitbucket app password with the required permissions, refer to the [Add Git Server](../../user-guide/add-git-server.md) guide.
@@ -449,7 +457,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
449457
enabled: true
450458
```
451459

452-
2. Update the KrakenD configuration to include the GitFusion API endpoints.
460+
2. Update the KrakenD configuration to include the GitFusion API endpoints:
453461

454462
:::note
455463
The latest KrakenD configuration can be found in the [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/krakend) repository.
@@ -798,7 +806,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
798806
```
799807
</details>
800808

801-
3. Update the KrakenD secret with the GitFusion URL variable.
809+
3. Update the KrakenD secret with the GitFusion URL variable:
802810

803811
:::note
804812
The `GITFUSION_URL` variable should point to the GitFusion service URL, e.g., `http://gitfusion.krci:8080`.
@@ -841,7 +849,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
841849

842850
![GitFusion](../../assets/operator-guide/upgrade/gitfusion.png)
843851

844-
3. (Optional) Align Remote Cluster Names
852+
4. (Optional) Align Remote Cluster Names:
845853

846854
In case of using remote clusters in KubeRocketCI, it is necessary to update the remote cluster names in KubeRocketCI portal after upgrading to version 3.12.
847855

@@ -851,37 +859,37 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
851859

852860
There are two ways to align the remote cluster names in the KubeRocketCI portal:
853861

854-
1. Recreate the remote cluster integration in the KubeRocketCI portal.
862+
1. Recreate the remote cluster integration in the KubeRocketCI portal:
855863

856864
1. Navigate to the **Configuration** -> **Deployment** -> **Clusters** section in the KubeRocketCI portal.
857865

858-
2. Click on the cluster integration that needs to be updated and delete it by clicking the **Delete** (trash can) icon.
866+
2. Click on the cluster integration that needs to be updated and delete it by clicking the **Delete** (trash can) icon:
859867

860868
![Delete Cluster](../../assets/operator-guide/upgrade/delete-cluster.png)
861869

862870
Confirm the deletion in the pop-up window.
863871

864-
3. After the cluster integration is deleted, click the **Add Cluster** button to create a new cluster integration. Fill in the required fields and click the **Save** button to add the cluster.
872+
3. After the cluster integration is deleted, click the **Add Cluster** button to create a new cluster integration. Fill in the required fields and click the **Save** button to add the cluster:
865873

866874
![Add Cluster](../../assets/operator-guide/upgrade/add-cluster.png)
867875

868876
After the new cluster integration is created, the correct cluster name will be displayed in the KubeRocketCI portal.
869877

870-
2. Update the `kubeconfig` specification in the `<cluster-name>` Kubernetes secret.
878+
2. Update the `kubeconfig` specification in the `<cluster-name>` Kubernetes secret:
871879

872880
:::note
873881
The `<cluster-name>` secret is created automatically when a new cluster integration is added in the KubeRocketCI portal. The secret contains the `kubeconfig` specification used to connect to the remote cluster.
874882
:::
875883

876884
It is also possible to update the `kubeconfig` specification in the existing `<cluster-name>` secret to change the cluster name, instead of recreating the cluster integration in the KubeRocketCI portal.
877885

878-
1. Locate the `<cluster-name>` secret in the namespace where KubeRocketCI is installed (e.g., `krci` namespace).
886+
1. Locate the `<cluster-name>` secret in the namespace where KubeRocketCI is installed (e.g., `krci` namespace):
879887

880888
```bash
881889
kubectl get secret <cluster-name> -n krci -o yaml
882890
```
883891

884-
2. Update the `kubeconfig` specification by changing the `clusters.name` and `contexts.context.cluster` fields to match the desired cluster name.
892+
2. Update the `kubeconfig` specification by changing the `clusters.name` and `contexts.context.cluster` fields to match the desired cluster name:
885893

886894
:::note
887895
The `data.config` field in the secret is base64 encoded. To update the `kubeconfig` specification, decode the `data.config` field, make the necessary changes, and then encode it back to base64 before updating the secret.
@@ -926,7 +934,7 @@ In version 3.12, the `docker.io/epamedp/tekton-cache` image has been [deprecated
926934

927935
After updating the `kubeconfig` specification in the secret, the correct cluster name will be displayed in the KubeRocketCI portal.
928936

929-
4. To upgrade KubeRocketCI to the v3.12, run the following commands:
937+
5. To upgrade KubeRocketCI to the v3.12, run the following commands:
930938

931939
:::note
932940
To verify the installation, it is possible to test the deployment before applying it to the cluster with the `--dry-run` key:

0 commit comments

Comments
 (0)