Skip to content

Commit

Permalink
chore: Update KubeRocketCI names and documentation links (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
daniil-nedostup authored and MykolaMarusenko committed Aug 9, 2024
1 parent 1297f04 commit 9127c4b
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 34 deletions.
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
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,27 @@

# Gerrit 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 Gerrit Operator and the installation process as well as the local development, and architecture scheme.

## Overview

Gerrit Operator is an EDP operator that is responsible for installing and configuring Gerrit. Operator installation can be applied on OpenShift container orchestration platform.
Gerrit Operator is a KubeRocketCI operator that is responsible for installing and configuring Gerrit. Operator installation can be applied on OpenShift container orchestration platform.

_**NOTE:** Operator is platform-independent, that is why there is a unified instruction for deploying._

## Prerequisites

1. Linux machine or Windows Subsystem for Linux instance with [Helm 3](https://helm.sh/docs/intro/install/) installed;
2. Cluster admin access to the cluster;
3. EDP project/namespace is deployed by following the [Install EDP](https://epam.github.io/edp-install/operator-guide/install-edp/) instruction.
3. KubeRocketCI project/namespace is deployed by following the [Install KubeRocketCI](https://docs.kuberocketci.io/docs/operator-guide/install-kuberocketci) instruction.
4. Make sure Git [`FSMonitor`](https://www.git-scm.com/docs/git-fsmonitor--daemon) feature is turned off. This is due to [limitations](https://github.com/go-git/go-git/issues/299) of `go-git`.

## Installation

In order to install the EDP Gerrit Operator, follow the steps below:
In order to install the KubeRocketCI Gerrit Operator, follow the steps below:

1. To add the Helm EPAMEDP Charts for local client, run "helm repo add":
```bash
Expand All @@ -35,8 +35,7 @@ In order to install the EDP Gerrit Operator, follow the steps below:
```bash
helm search repo epamedp/gerrit-operator -l
NAME CHART VERSION APP VERSION DESCRIPTION
epamedp/gerrit-operator 2.19.0 2.19.0 A Helm chart for EDP Gerrit Operator
epamedp/gerrit-operator 2.18.0 2.18.0 A Helm chart for EDP Gerrit Operator
epamedp/gerrit-operator 2.21.0 2.21.0 A Helm chart for KubeRocketCI Gerrit Operator
```

_**NOTE:** It is highly recommended to use the latest released version._
Expand All @@ -51,11 +50,11 @@ In order to install the EDP Gerrit 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 [Developer Guide](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

- [Architecture Scheme of Gerrit Operator](documentation/arch.md)
- [Install EDP](https://epam.github.io/edp-install/operator-guide/install-edp/)
- [Install KubeRocketCI](https://docs.kuberocketci.io/docs/operator-guide/install-kuberocketci)
3 changes: 0 additions & 3 deletions build.groovy

This file was deleted.

2 changes: 1 addition & 1 deletion build/configs/scripts/init-all-projects.sh
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ cat << EOF > \"webhooks.config\"
EOF

git add .
git commit -a -m \"Uploaded EDP Gerrit config\"
git commit -a -m \"Uploaded KRCI Gerrit config\"
git push origin HEAD:refs/meta/config
git config -f /var/gerrit/review_site/etc/gerrit.config auth.trustedOpenID ^.*\$
3 changes: 0 additions & 3 deletions code-review.groovy

This file was deleted.

3 changes: 0 additions & 3 deletions create-release.groovy

This file was deleted.

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 Gerrit Operator
home: https://epam.github.io/edp-install/
description: A Helm chart for KubeRocketCI Gerrit Operator
home: https://docs.kuberocketci.io/
name: gerrit-operator
type: application
version: 2.22.0-SNAPSHOT
appVersion: 2.22.0-SNAPSHOT
icon: https://epam.github.io/edp-install/assets/logo.png
icon: https://docs.kuberocketci.io/img/logo.svg
keywords:
- edp
- gerrit
Expand All @@ -14,7 +14,7 @@ keywords:
maintainers:
- name: epmd-edp
email: [email protected]
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:
min: -1
max: 1
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
10 changes: 5 additions & 5 deletions deploy-templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

![Version: 2.22.0-SNAPSHOT](https://img.shields.io/badge/Version-2.22.0--SNAPSHOT-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.22.0-SNAPSHOT](https://img.shields.io/badge/AppVersion-2.22.0--SNAPSHOT-informational?style=flat-square)

A Helm chart for EDP Gerrit Operator
A Helm chart for KubeRocketCI Gerrit Operator

**Homepage:** <https://epam.github.io/edp-install/>
**Homepage:** <https://docs.kuberocketci.io/>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| epmd-edp | <[email protected]> | <https://solutionshub.epam.com/solution/epam-delivery-platform> |
| epmd-edp | <[email protected]> | <https://solutionshub.epam.com/solution/kuberocketci> |
| sergk | | <https://github.com/SergK> |

## Source Code
Expand Down Expand Up @@ -57,8 +57,8 @@ A Helm chart for EDP Gerrit Operator
| global.openshift.deploymentType | string | `"deployments"` | Which type of kind will be deployed to Openshift (values: deployments/deploymentConfigs) |
| global.platform | string | `"openshift"` | platform type that can be "kubernetes" or "openshift" |
| groupMemberSyncInterval | string | `"30m"` | If not defined the exponential formula with the max value of 1hr will be used |
| image.repository | string | `"epamedp/gerrit-operator"` | EDP gerrit-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/gerrit-operator) |
| image.tag | string | `nil` | EDP gerrit-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/gerrit-operator/tags) |
| image.repository | string | `"epamedp/gerrit-operator"` | KubeRocketCI gerrit-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/gerrit-operator) |
| image.tag | string | `nil` | KubeRocketCI gerrit-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/gerrit-operator/tags) |
| imagePullPolicy | string | `"IfNotPresent"` | |
| name | string | `"gerrit-operator"` | component name |
| nodeSelector | object | `{}` | |
Expand Down
4 changes: 2 additions & 2 deletions deploy-templates/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ nodeSelector: {}
tolerations: []
affinity: {}
image:
# -- EDP gerrit-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/gerrit-operator)
# -- KubeRocketCI gerrit-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/gerrit-operator)
repository: epamedp/gerrit-operator
# -- if not defined then .Chart.AppVersion is used
# -- EDP gerrit-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/gerrit-operator/tags)
# -- KubeRocketCI gerrit-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/gerrit-operator/tags)
tag:
imagePullPolicy: "IfNotPresent"

Expand Down

0 comments on commit 9127c4b

Please sign in to comment.