From 066481c6a13c42ac354c9444a2c8ddacfd634180 Mon Sep 17 00:00:00 2001 From: Daniil Nedostup Date: Thu, 8 Aug 2024 19:52:53 +0300 Subject: [PATCH] chore: Update KubeRocketCI names and documentation links (#25) --- .github/workflows/release.yaml | 4 ++-- README.md | 13 ++++++------- deploy-templates/Chart.yaml | 14 +++++++------- deploy-templates/README.md | 21 ++++++++++----------- deploy-templates/README.md.gotmpl | 11 +++++------ deploy-templates/values.yaml | 4 ++-- 6 files changed, 32 insertions(+), 35 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index ce725e1..90a38a9 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 4cf24e4..a5c9d3d 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@ # Sonar Operator -| :heavy_exclamation_mark: Please refer to [EDP documentation](https://epam.github.io/edp-install/) to get the notion of the main concepts and guidelines. | +| :heavy_exclamation_mark: Please refer to [KubeRocketCI documentation](https://docs.kuberocketci.io/) to get the notion of the main concepts and guidelines. | | --- | Get acquainted with the Sonar Operator and the installation process as well as the local development, and architecture scheme. ## Overview -Sonar Operator is an EDP operator that is responsible for configuring SonarQube. +Sonar Operator is a KubeRocketCI operator that is responsible for configuring SonarQube. _**NOTE:** Operator is platform-independent, that is why there is a unified instruction for deploying._ @@ -20,7 +20,7 @@ _**NOTE:** Operator is platform-independent, that is why there is a unified inst ## Installation -In order to install the EDP Sonar Operator, follow the steps below: +In order to install the KubeRocketCI Sonar Operator, follow the steps below: 1. To add the Helm EPAMEDP Charts for local client, run "helm repo add": @@ -33,8 +33,7 @@ In order to install the EDP Sonar Operator, follow the steps below: ```bash helm search repo epamedp/sonar-operator -l NAME CHART VERSION APP VERSION DESCRIPTION - epamedp/sonar-operator 3.1.1 3.1.1 A Helm chart for EDP Sonar Operator - epamedp/sonar-operator 3.1.0 3.1.0 A Helm chart for EDP Sonar Operator + epamedp/sonar-operator 3.1.1 3.1.1 A Helm chart for KRCI Sonar Operator ``` _**NOTE:** It is highly recommended to use the latest released version._ @@ -118,10 +117,10 @@ In order to install the EDP Sonar Operator, follow the steps below: ## Local Development -In order to develop the operator, first set up a local environment. For details, please refer to the [Local Development](https://epam.github.io/edp-install/developer-guide/local-development/) page. +In order to develop the operator, first set up a local environment. For details, please refer to the [Local Development](https://docs.kuberocketci.io/docs/developer-guide/local-development) page. Development versions are also available, please refer to 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) diff --git a/deploy-templates/Chart.yaml b/deploy-templates/Chart.yaml index d5eb03c..553c0dd 100644 --- a/deploy-templates/Chart.yaml +++ b/deploy-templates/Chart.yaml @@ -1,11 +1,11 @@ apiVersion: v2 -description: A Helm chart for EDP Sonar Operator -home: https://epam.github.io/edp-install/ +description: A Helm chart for KubeRocketCI Sonar Operator +home: https://docs.kuberocketci.io/ name: sonar-operator type: application version: 3.2.0-SNAPSHOT appVersion: 3.2.0-SNAPSHOT -icon: https://epam.github.io/edp-install/assets/logo.png +icon: https://docs.kuberocketci.io/img/logo.svg keywords: - edp - sonarqube @@ -14,7 +14,7 @@ keywords: maintainers: - name: epmd-edp email: SupportEPMD-EDP@epam.com - url: https://solutionshub.epam.com/solution/epam-delivery-platform + url: https://solutionshub.epam.com/solution/kuberocketci - name: sergk url: https://github.com/SergK sources: @@ -141,7 +141,7 @@ annotations: name: sonar 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 diff --git a/deploy-templates/README.md b/deploy-templates/README.md index 1e13ce5..49d444f 100644 --- a/deploy-templates/README.md +++ b/deploy-templates/README.md @@ -2,13 +2,13 @@ ![Version: 3.2.0-SNAPSHOT](https://img.shields.io/badge/Version-3.2.0--SNAPSHOT-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 3.2.0-SNAPSHOT](https://img.shields.io/badge/AppVersion-3.2.0--SNAPSHOT-informational?style=flat-square) -A Helm chart for EDP Sonar Operator +A Helm chart for KubeRocketCI Sonar Operator -**Homepage:** +**Homepage:** ## Overview -Sonar Operator is an EDP operator that is responsible for configuring SonarQube. +Sonar Operator is a KubeRocketCI operator that is responsible for configuring SonarQube. _**NOTE:** Operator is platform-independent, that is why there is a unified instruction for deploying._ @@ -19,7 +19,7 @@ _**NOTE:** Operator is platform-independent, that is why there is a unified inst ## Installation -In order to install the EDP Sonar Operator, follow the steps below: +In order to install the KubeRocketCI Sonar Operator, follow the steps below: 1. To add the Helm EPAMEDP Charts for local client, run "helm repo add": @@ -32,8 +32,7 @@ In order to install the EDP Sonar Operator, follow the steps below: ```bash helm search repo epamedp/sonar-operator -l NAME CHART VERSION APP VERSION DESCRIPTION - epamedp/sonar-operator 3.1.1 3.1.1 A Helm chart for EDP Sonar Operator - epamedp/sonar-operator 3.1.0 3.1.0 A Helm chart for EDP Sonar Operator + epamedp/sonar-operator 3.1.1 3.1.1 A Helm chart for KubeRocketCI Sonar Operator ``` _**NOTE:** It is highly recommended to use the latest released version._ @@ -117,19 +116,19 @@ In order to install the EDP Sonar Operator, follow the steps below: ## Local Development -In order to develop the operator, first set up a local environment. For details, please refer to the [Local Development](https://epam.github.io/edp-install/developer-guide/local-development/) page. +In order to develop the operator, first set up a local environment. For details, please refer to the [Local Development](https://docs.kuberocketci.io/docs/developer-guide/local-development) page. Development versions are also available, please refer to 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 | Name | Email | Url | | ---- | ------ | --- | -| epmd-edp | | | +| epmd-edp | | | | sergk | | | ## Source Code @@ -144,8 +143,8 @@ Development versions are also available, please refer to the [snapshot helm char | annotations | object | `{}` | | | extraVolumeMounts | list | `[]` | Additional volumeMounts to be added to the container | | extraVolumes | list | `[]` | Additional volumes to be added to the pod | -| image.repository | string | `"epamedp/sonar-operator"` | EDP sonar-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/sonar-operator) | -| image.tag | string | `nil` | EDP sonar-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/sonar-operator/tags) | +| image.repository | string | `"epamedp/sonar-operator"` | KubeRocketCI sonar-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/sonar-operator) | +| image.tag | string | `nil` | KubeRocketCI sonar-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/sonar-operator/tags) | | imagePullPolicy | string | `"IfNotPresent"` | | | name | string | `"sonar-operator"` | component name | | nodeSelector | object | `{}` | | diff --git a/deploy-templates/README.md.gotmpl b/deploy-templates/README.md.gotmpl index 5286758..7824fb2 100644 --- a/deploy-templates/README.md.gotmpl +++ b/deploy-templates/README.md.gotmpl @@ -9,7 +9,7 @@ ## Overview -Sonar Operator is an EDP operator that is responsible for configuring SonarQube. +Sonar Operator is a KubeRocketCI operator that is responsible for configuring SonarQube. _**NOTE:** Operator is platform-independent, that is why there is a unified instruction for deploying._ @@ -20,7 +20,7 @@ _**NOTE:** Operator is platform-independent, that is why there is a unified inst ## Installation -In order to install the EDP Sonar Operator, follow the steps below: +In order to install the KubeRocketCI Sonar Operator, follow the steps below: 1. To add the Helm EPAMEDP Charts for local client, run "helm repo add": @@ -33,8 +33,7 @@ In order to install the EDP Sonar Operator, follow the steps below: ```bash helm search repo epamedp/sonar-operator -l NAME CHART VERSION APP VERSION DESCRIPTION - epamedp/sonar-operator 3.1.1 3.1.1 A Helm chart for EDP Sonar Operator - epamedp/sonar-operator 3.1.0 3.1.0 A Helm chart for EDP Sonar Operator + epamedp/sonar-operator 3.1.1 3.1.1 A Helm chart for KubeRocketCI Sonar Operator ``` _**NOTE:** It is highly recommended to use the latest released version._ @@ -118,13 +117,13 @@ In order to install the EDP Sonar Operator, follow the steps below: ## Local Development -In order to develop the operator, first set up a local environment. For details, please refer to the [Local Development](https://epam.github.io/edp-install/developer-guide/local-development/) page. +In order to develop the operator, first set up a local environment. For details, please refer to the [Local Development](https://docs.kuberocketci.io/docs/developer-guide/local-development) page. Development versions are also available, please refer to 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 616c29b..9f59282 100644 --- a/deploy-templates/values.yaml +++ b/deploy-templates/values.yaml @@ -5,10 +5,10 @@ nodeSelector: {} tolerations: [] affinity: {} image: - # -- EDP sonar-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/sonar-operator) + # -- KubeRocketCI sonar-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/sonar-operator) repository: epamedp/sonar-operator # if not defined then .Chart.AppVersion is used - # -- EDP sonar-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/sonar-operator/tags) + # -- KubeRocketCI sonar-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/sonar-operator/tags) tag: imagePullPolicy: "IfNotPresent"