Skip to content

Commit

Permalink
ROX-20025: Add Gitops dev doc (#1519)
Browse files Browse the repository at this point in the history
* Add overview doc

* Add an overview doc for gitops
  • Loading branch information
kurlov authored Dec 8, 2023
1 parent 490c876 commit 5685d54
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ To contact the people that created this template go to [zulip](https://bf2.zulip
- [Access Control](docs/legacy/access-control.md)
- [Quota Management](docs/quota/quota.md)
- [Explanation of JWT token claims used across the fleet-manager](docs/auth/jwt-claims.md)
- [Gitops: configure ACS Central and ACS Operator](docs/development/gitops-configure-central-and-operator.md)

## Contributing

Expand Down
35 changes: 35 additions & 0 deletions docs/development/gitops-configure-central-and-operator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Gitops: configure ACS Central and ACS Operator


## Overview

Gitops provides a declarative configuration for ACS Central instances and ACS Operator.
GitOps relies on private repository to track changes to the configuration files.
[The repository](#gitops-repository) contains desired state for each environment configuration.


### Gitops repository

See: [Gitops repo](https://gitlab.cee.redhat.com/stackrox/acs-cloud-service/config)

### Gitops Flow

See: [detailed diagram](../../internal/dinosaur/pkg/gitops/README.md)


## Benefits

- **Consistency**: GitOps ensures consistency between configuration and state of the clusters on each environment.

- **Flexibility**: Gitops makes it possible to run multiple ACS operators simultaneously. It's also easy to override almost anything for the Central.

- **Validation**: GitOps repository CI validates each changes to spot configuration error as soon as possible.

- **Collaboration**: It's easy to make changes, review and then late merge it to the repository.

- **Auditability**: The versioned history of changes makes it easy to understand by whom, when and why changes were made.


## Canary rollout

See: [release instructions](https://gitlab.cee.redhat.com/stackrox/acs-cloud-service/config#release-rollout)

0 comments on commit 5685d54

Please sign in to comment.