From 20a6597565facf0d1c88c5f4bb5e7e940aabfb51 Mon Sep 17 00:00:00 2001 From: Daniil Nedostup Date: Thu, 8 Aug 2024 20:11:29 +0300 Subject: [PATCH] chore: Update KubeRocketCI names and documentation links (#91) --- .github/workflows/release.yaml | 4 ++-- README.md | 11 +++++------ deploy-templates/Chart.yaml | 10 +++++----- deploy-templates/README.md | 15 +++++++-------- deploy-templates/README.md.gotmpl | 9 ++++----- deploy-templates/values.yaml | 4 ++-- 6 files changed, 25 insertions(+), 28 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 50cc0fc8..fce35733 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -1,4 +1,4 @@ -name: Create EDP release +name: Create KRCI release on: push: tags: @@ -65,7 +65,7 @@ jobs: # Create a new file with the desired text and the UUIDs echo "### Deployment Certifications and Source Traceability" > new_release.md - echo "EDP container images bear [cosign](https://github.com/sigstore/cosign) signatures. Refer to the [documentation](https://epam.github.io/edp-install/operator-guide/artifacts-verification/) for instructions on verification." >> new_release.md + echo "KubeRocketCI container images bear [cosign](https://github.com/sigstore/cosign) signatures. Refer to the [documentation](https://docs.kuberocketci.io/docs/developer-guide/artifacts-verification) for instructions on verification." >> new_release.md echo "The Rekor UUID's for this release is \`${ATTESTATION_UUID}\` - attestation and" >> new_release.md echo "\`${SIGNATURE_UUID}\` - signature" >> new_release.md diff --git a/README.md b/README.md index 78e40743..c0b15868 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@ # Keycloak Operator -| :heavy_exclamation_mark: Please refer to [EDP documentation](https://epam.github.io/edp-install/) to get the main concepts and guidelines. | +| :heavy_exclamation_mark: Please refer to [KubeRocketCI documentation](https://docs.kuberocketci.io/) to get the main concepts and guidelines. | | --- | Get acquainted with the Keycloak Operator, the installation process, the quick start, and the local development guidelines. ## Overview -Keycloak Operator is an EDP operator responsible for configuring existing Keycloak instances. The operator runs both on OpenShift and Kubernetes. +Keycloak Operator is a KubeRocketCI operator responsible for configuring existing Keycloak instances. The operator runs both on OpenShift and Kubernetes. _**NOTE:** Operator is platform-independent, which is why there is a unified instruction for deployment._ @@ -33,8 +33,7 @@ To install the Keycloak Operator, follow the steps below: ```bash helm search repo epamedp/keycloak-operator -l NAME CHART VERSION APP VERSION DESCRIPTION - epamedp/keycloak-operator 1.22.0 1.22.0 A Helm chart for EDP Keycloak Operator - epamedp/keycloak-operator 1.21.0 1.21.0 A Helm chart for EDP Keycloak Operator + epamedp/keycloak-operator 1.22.0 1.22.0 A Helm chart for KRCI Keycloak Operator ``` _**NOTE:** It is highly recommended to use the latest stable version._ @@ -127,10 +126,10 @@ To prevent the operator from deleting resources from Keycloak, add the `edp.epam ## Local Development -To develop the operator, first set up a local environment, and refer to the [Local Development](https://epam.github.io/edp-install/developer-guide/local-development/) page. +To develop the operator, first set up a local environment, and refer to the [Local Development](https://docs.kuberocketci.io/docs/developer-guide/local-development) page. Development versions are also available from the [snapshot Helm Chart repository](https://epam.github.io/edp-helm-charts/snapshot/) page. ### Related Articles -* [Install KubeRocketCI](https://docs.kuberocketci.io/docs/operator-guide/installation-overview?utm_source=github&utm_medium=keyqcloak_readme&utm_campaign=installation) +* [Install KubeRocketCI](https://docs.kuberocketci.io/docs/operator-guide/install-kuberocketci) diff --git a/deploy-templates/Chart.yaml b/deploy-templates/Chart.yaml index d143b4f1..1095e40b 100644 --- a/deploy-templates/Chart.yaml +++ b/deploy-templates/Chart.yaml @@ -1,11 +1,11 @@ apiVersion: v2 -description: A Helm chart for EDP Keycloak Operator +description: A Helm chart for KubeRocketCI Keycloak Operator home: https://docs.kuberocketci.io/ name: keycloak-operator type: application version: 1.23.0-SNAPSHOT appVersion: 1.23.0-SNAPSHOT -icon: https://epam.github.io/edp-install/assets/logo.png +icon: https://docs.kuberocketci.io/img/logo.svg keywords: - authentication - authorization @@ -298,10 +298,10 @@ annotations: secret: secret-name-in-operator-ns url: https://keycloak.example.com artifacthub.io/links: | - - name: EDP Documentation - url: https://epam.github.io/edp-install/ + - name: KubeRocketCI Documentation + url: https://docs.kuberocketci.io - name: EPAM SolutionHub - url: https://solutionshub.epam.com/solution/epam-delivery-platform + url: https://solutionshub.epam.com/solution/kuberocketci artifacthub.io/changes: | - Add frontend url property for realm - Allow define KeycloakRealmUser password in Kubernetes secret diff --git a/deploy-templates/README.md b/deploy-templates/README.md index bd72f13d..b7c726d6 100644 --- a/deploy-templates/README.md +++ b/deploy-templates/README.md @@ -2,13 +2,13 @@ ![Version: 1.23.0-SNAPSHOT](https://img.shields.io/badge/Version-1.23.0--SNAPSHOT-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.23.0-SNAPSHOT](https://img.shields.io/badge/AppVersion-1.23.0--SNAPSHOT-informational?style=flat-square) -A Helm chart for EDP Keycloak Operator +A Helm chart for KubeRocketCI Keycloak Operator **Homepage:** ## Overview -Keycloak Operator is an EDP operator responsible for configuring existing Keycloak instances. The operator runs both on OpenShift and Kubernetes. +Keycloak Operator is a KubeRocketCI operator responsible for configuring existing Keycloak instances. The operator runs both on OpenShift and Kubernetes. _**NOTE:** Operator is platform-independent, which is why there is a unified instruction for deployment._ @@ -32,8 +32,7 @@ To install the Keycloak Operator, follow the steps below: ```bash helm search repo epamedp/keycloak-operator -l NAME CHART VERSION APP VERSION DESCRIPTION - epamedp/keycloak-operator 1.19.0 1.19.0 A Helm chart for EDP Keycloak Operator - epamedp/keycloak-operator 1.18.2 1.18.2 A Helm chart for EDP Keycloak Operator + epamedp/keycloak-operator 1.22.0 1.22.0 A Helm chart for KRCI Keycloak Operator ``` _**NOTE:** It is highly recommended to use the latest stable version._ @@ -105,13 +104,13 @@ To install the Keycloak Operator, follow the steps below: ## Local Development -To develop the operator, first set up a local environment, and refer to the [Local Development](https://epam.github.io/edp-install/developer-guide/local-development/) page. +To develop the operator, first set up a local environment, and refer to the [Local Development](https://docs.kuberocketci.io/docs/developer-guide/local-development) page. Development versions are also available from the [snapshot helm chart repository](https://epam.github.io/edp-helm-charts/snapshot/) page. ### Related Articles -* [Install EDP](https://epam.github.io/edp-install/operator-guide/install-edp/) +* [Install KubeRocketCI](https://docs.kuberocketci.io/docs/operator-guide/install-kuberocketci) ## Maintainers @@ -133,8 +132,8 @@ Development versions are also available from the [snapshot helm chart repository | clusterReconciliationEnabled | bool | `false` | If clusterReconciliationEnabled is true, the operator reconciles all Keycloak instances in the cluster; otherwise, it only reconciles instances in the same namespace by default, and cluster-scoped resources are ignored. | | extraVolumeMounts | list | `[]` | Additional volumeMounts to be added to the container | | extraVolumes | list | `[]` | Additional volumes to be added to the pod | -| image.repository | string | `"epamedp/keycloak-operator"` | EDP keycloak-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/keycloak-operator) | -| image.tag | string | `nil` | EDP keycloak-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/keycloak-operator/tags) | +| image.repository | string | `"epamedp/keycloak-operator"` | KubeRocketCI keycloak-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/keycloak-operator) | +| image.tag | string | `nil` | KubeRocketCI keycloak-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/keycloak-operator/tags) | | imagePullPolicy | string | `"IfNotPresent"` | If defined, a imagePullPolicy applied to the deployment | | imagePullSecrets | list | `[]` | If defined, imagePullSecrets are applied to deployment | | name | string | `"keycloak-operator"` | Application name string | diff --git a/deploy-templates/README.md.gotmpl b/deploy-templates/README.md.gotmpl index 1c8566b8..6bb74253 100644 --- a/deploy-templates/README.md.gotmpl +++ b/deploy-templates/README.md.gotmpl @@ -9,7 +9,7 @@ ## Overview -Keycloak Operator is an EDP operator responsible for configuring existing Keycloak instances. The operator runs both on OpenShift and Kubernetes. +Keycloak Operator is a KubeRocketCI operator responsible for configuring existing Keycloak instances. The operator runs both on OpenShift and Kubernetes. _**NOTE:** Operator is platform-independent, which is why there is a unified instruction for deployment._ @@ -33,8 +33,7 @@ To install the Keycloak Operator, follow the steps below: ```bash helm search repo epamedp/keycloak-operator -l NAME CHART VERSION APP VERSION DESCRIPTION - epamedp/keycloak-operator 1.19.0 1.19.0 A Helm chart for EDP Keycloak Operator - epamedp/keycloak-operator 1.18.2 1.18.2 A Helm chart for EDP Keycloak Operator + epamedp/keycloak-operator 1.22.0 1.22.0 A Helm chart for KRCI Keycloak Operator ``` _**NOTE:** It is highly recommended to use the latest stable version._ @@ -106,13 +105,13 @@ To install the Keycloak Operator, follow the steps below: ## Local Development -To develop the operator, first set up a local environment, and refer to the [Local Development](https://epam.github.io/edp-install/developer-guide/local-development/) page. +To develop the operator, first set up a local environment, and refer to the [Local Development](https://docs.kuberocketci.io/docs/developer-guide/local-development) page. Development versions are also available from the [snapshot helm chart repository](https://epam.github.io/edp-helm-charts/snapshot/) page. ### Related Articles -* [Install EDP](https://epam.github.io/edp-install/operator-guide/install-edp/) +* [Install KubeRocketCI](https://docs.kuberocketci.io/docs/operator-guide/install-kuberocketci) {{ template "chart.maintainersSection" . }} diff --git a/deploy-templates/values.yaml b/deploy-templates/values.yaml index 3e577476..fbd6ae53 100644 --- a/deploy-templates/values.yaml +++ b/deploy-templates/values.yaml @@ -9,10 +9,10 @@ tolerations: [] # -- Affinity for pod assignment affinity: {} image: - # -- EDP keycloak-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/keycloak-operator) + # -- KubeRocketCI keycloak-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/keycloak-operator) repository: epamedp/keycloak-operator # if not defined then .Chart.AppVersion is used - # -- EDP keycloak-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/keycloak-operator/tags) + # -- KubeRocketCI keycloak-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/keycloak-operator/tags) tag: # -- If defined, a imagePullPolicy applied to the deployment imagePullPolicy: "IfNotPresent"