epam / edp-gerrit-operator Goto Github PK

View Code? Open in Web Editor NEW

4.0 7.0 4.0 1.21 MB

This operator installs and manages Gerrit EDP Component in order to use it as GitProvider and store codebases code

Home Page: https://docs.kuberocketci.io

License: Apache License 2.0

Dockerfile 0.15% Groovy 0.07% Shell 0.91% Go 96.39% Smarty 0.82% Makefile 1.66%

ci cd gerrit operator kubernetes k8s edp git gerrit-operator kuberocketci

edp-gerrit-operator's Introduction

Gerrit Operator

❗ Please refer to EDP documentation 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.

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

Prerequisites

Linux machine or Windows Subsystem for Linux instance with Helm 3 installed;
Cluster admin access to the cluster;
EDP project/namespace is deployed by following the Install EDP instruction.
Make sure Git FSMonitor feature is turned off. This is due to limitations of go-git.

Installation

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

To add the Helm EPAMEDP Charts for local client, run "helm repo add":
```
helm repo add epamedp https://epam.github.io/edp-helm-charts/stable
```

Choose available Helm chart version:

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

NOTE: It is highly recommended to use the latest released version.

Full chart parameters available in deploy-templates/README.md.

Install operator in the namespace with the helm command; find below the installation command example:

helm install gerrit-operator epamedp/gerrit-operator --version <chart_version> --namespace <edp-project> --set name=gerrit-operator --set global.platform=<platform_type> --set global.dnsWildCard=<cluster_DNS_wildcard>

Check the namespace that should contain Deployment with your operator in a running status.

Local Development

In order to develop the operator, first set up a local environment. For details, please refer to the Local Development page.

Development versions are also available, please refer to the snapshot Helm Chart repository page.

edp-gerrit-operator's People

Contributors

Stargazers

Watchers

Forkers

zmotso valkolesnikov secretiverabbit rolika4

edp-gerrit-operator's Issues

Align charts for ingress TLS configuration

Acceptance criteria:

update pattern for resource creation.

Describe GerritMergeRequest CR

How to use GerritMergeRequest CR needs to be clarified.

Add a description for every spec field.
Add examples of how to use GerritMergeRequest CR.

Release 2.19.0

Acceptance Criteria:

Release gerrit-operator 2.19.0 with latest fixes, features;

Enhance Keycloak Integration Flexibility for EDP Gerrit Operator

Is your feature request related to a problem? Please describe.
Currently, the EDP Gerrit Operator has restrictions regarding its integration with Keycloak, limiting the flexibility and potential configurations that can be achieved.

Describe the solution you'd like
We need a more flexible approach to Keycloak integration that allows for a broader range of configurations and use cases. This could involve expanding the operator's capabilities to support additional authentication and authorization scenarios, making it easier to integrate with different Keycloak setups.

Describe alternatives you've considered
An alternative might involve manual configuration or workarounds, but these are not desirable as they can be error-prone and hard to maintain.

Additional context
Improving the Keycloak integration flexibility will greatly enhance the usability and adaptability of the EDP Gerrit Operator, making it a more powerful tool for managing Gerrit instances with various security and authentication requirements.

Acceptance Criteria:

The EDP Gerrit Operator supports a wider range of Keycloak integration scenarios.
Documentation is updated to reflect the new integration capabilities.
Integration tests are added to ensure the new functionalities work as expected.

Implementation Plan:

Analyze the current Keycloak integration limitations.
Design a solution that adds the desired flexibility.
Implement the changes in the EDP Gerrit Operator codebase.
Update the documentation to include the new integration options.
Add integration tests covering the new functionalities.

Add label to the secret gerrit-ciuser-sshkey

Add label app.edp.epam.com/secret-type=repository to the secret gerrit-ciuser-sshkey.
We need this label app.edp.epam.com/secret-type=repository to show secret on the UI.

Release 2.20.0

Acceptance Criteria:

Release gerrit-operator 2.20.0 with latest fixes, features;

Use of Cryptographically weak PRNG in file helpers.go

Method marshalED25519PrivateKey at line 155 of \edp-gerrit-operator\pkg\service\helpers\helpers.go uses a weak method Uint32 to produce random values. These values are then used as cryptographic variables by marshalED25519PrivateKey at line 155 in \edp-gerrit-operator\pkg\service\helpers\helpers.go.

Release 2.16.0

Acceptance Criteria:

gerrit-operator 2.16.0 released;

Add the ability to remove the files with GerritMergeRequest CR

Use format: {"path": "/controllers/user.go", "contents": "some code here"} - to add the file.
And format: {"path": "/controllers/user.go"} - to remove the file.

Remove edpcomponents creation from operator workflow

Remove edpcomponents provisioning from operator workflow

Define name convention for ingress objects

Acceptance Criteria:

values.yaml file contain valid example of ingress/route host;

Align web-hook endpoint with Gerrit Tekton EventListener

We need to use new endpoint for Gerrit EventListener

Release gerrit-operator 2.21.0

Is your feature request related to a problem? Please describe.
This request is for the release of gerrit-operator version 2.21.0, incorporating the latest fixes and features to improve the operator's functionality and reliability.

Describe the solution you'd like
The release process should ensure the following acceptance criteria are met:

Release gerrit-operator version 2.21.0 with the latest fixes and features.
Make the release image available for deployment.
Update and release the helm chart corresponding to version 2.21.0.
Create and publish a release tag for version 2.21.0 in the repository.

Describe alternatives you've considered
N/A

Additional context
This release aims to provide users with the latest enhancements and bug fixes for the gerrit-operator, ensuring better stability and performance.

Implement gerrit QuickLink Custom Resource

Acceptance Criteria:

The gerrit QuickLink Custom Resource is added.

Release 2.13.6

Acceptance Criteria:

gerrit-operator 2.13.6 released;

Bump gerrit image version to 3.7.2

Is your feature request related to a problem? Please describe.
We are currently using an outdated version of the Gerrit image in our development environment.

Describe the solution you'd like
I would like to update our Gerrit image to version 3.7.2

Enable gerrit restart flow

Is your feature request related to a problem? Please describe.
Currently, we disable keycloakSpec, but we still need to restart Gerrit after configuration.
https://github.com/epam/edp-gerrit-operator/blob/master/deploy-templates/templates/gerrit/gerrit.yaml#L9

Describe the solution you'd like
Restart Gerrit deployment here:
https://github.com/epam/edp-gerrit-operator/blob/master/pkg/service/gerrit/gerrit.go#L455

Enable Code Owners for project

Acceptance Criteria:

project contain valid code owners;
project configured with RBAC for contributors;

Bump to Go 1.22

Is your feature request related to a problem? Please describe.
Go version 1.20 needs to be updated. Most libraries already require a newer version.

Describe the solution you'd like
Bump Go from 1.20 to the 1.22 version.

Describe alternatives you've considered
Stay on the outdated 1.20 version.