Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update KubeRocketCI names and documentation links (#25) #26

Merged
merged 1 commit into from
Aug 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Create EDP release
name: Create KRCI release
on:
push:
tags:
Expand Down Expand Up @@ -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

Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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._

Expand All @@ -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":

Expand All @@ -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._
Expand Down Expand Up @@ -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)
14 changes: 7 additions & 7 deletions deploy-templates/Chart.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -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
21 changes: 10 additions & 11 deletions deploy-templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:** <https://epam.github.io/edp-install/>
**Homepage:** <https://docs.kuberocketci.io/>

## 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._

Expand All @@ -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":

Expand All @@ -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._
Expand Down Expand Up @@ -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 | <SupportEPMD-EDP@epam.com> | <https://solutionshub.epam.com/solution/epam-delivery-platform> |
| epmd-edp | <SupportEPMD-EDP@epam.com> | <https://solutionshub.epam.com/solution/kuberocketci> |
| sergk | | <https://github.com/SergK> |

## Source Code
Expand All @@ -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 | `{}` | |
Expand Down
11 changes: 5 additions & 6 deletions deploy-templates/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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._

Expand All @@ -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":

Expand All @@ -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._
Expand Down Expand Up @@ -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" . }}

Expand Down
4 changes: 2 additions & 2 deletions deploy-templates/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
Loading