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

docs: [DENA-600] CockroachDB README using shared-kustomize-bases README standard #55

Merged
merged 9 commits into from
Jul 31, 2024

Conversation

MarcinGinszt
Copy link
Collaborator

No description provided.

MarcinGinszt and others added 7 commits July 23, 2024 13:33
* add init job with example how to use it, enhance script and opslevel annotations

* restoring init job host parameter to find reason for faling db init

* deploy db-init script with cockroachdb

* move db init to separate directory

* replace image for db init container

* add resource to db init, add mock version to example

* remove tag pinning from examples, as it breaks the cicd

* reference current branch to unlock CICD

* add example, how to disable backups

* different approach to disabling backup- using kustomize components

* remove unnecessary resource in disable backup component

* trying different path

* move vault annotation from example to manifest

* place annotation in correct place

* improve comment

* update manifest checkers version
@MarcinGinszt MarcinGinszt requested a review from a team as a code owner July 24, 2024 13:08
Copy link

linear bot commented Jul 24, 2024

@MarcinGinszt MarcinGinszt changed the title [DENA-600] CockroachDB README using shared-kustomize-bases README standard docs: [DENA-600] CockroachDB README using shared-kustomize-bases README standard Jul 24, 2024
@@ -1,54 +1,30 @@
** Work in progress! State of this manifest should change in next days**
# Cockroachdb
# Redis
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Redis
# Cockroachdb

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- `manifests-cfssl` are **not recommended** for fresh install - they contain the manifests that demand
certificate authority deployed within the namespace. For more information,
see [CFSSL README](manifests-cfssl/CFSSL_README.md)
- `manifests-cert-manager` are using Kubernetes cert-manager controller,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This currently renders as a sub-point under the previous point

Suggested change
- `manifests-cert-manager` are using Kubernetes cert-manager controller,
- `manifests-cert-manager` are using Kubernetes cert-manager controller,

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is anything referencing the old file paths that needs to be updated before we merge this? Or do we assume downstream is pinned to a tag from this repo and not e.g. main?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think people know about this base in here, so I think it's highly unlikely to be used yet

Copy link
Collaborator Author

@MarcinGinszt MarcinGinszt Jul 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like us to archive cockroachdb-manifests (after checking, if kustomize accept archived repositories, to not break existing links).
Then, whole development of cockroachdb could move here.
I have to discuss that with wider public

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@matthewhughes-uw you are right, there were some remaining references, fixed

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This broke the kustomize build, so I added follow up commit changing tags

- The version of the `cockroachdb/cockroach` image the manifests are using
- An internal version to track changes to anything besides the version of
CockroachDB
- `manifests-cfssl` are **not recommended** for fresh install - they contain the manifests that demand
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ordering: maybe the recommend approach could be the first dot point? There are only two points here though so it doesn't make a huge difference

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


## Backup/ migration

Our CockroachDB is configured with backup by default.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given this, and

In order to configure backup, you must create Service Account

does that mean that, by default, if you forgot the Service Account things will not work? If so, maybe worth highlighting it here:

Suggested change
Our CockroachDB is configured with backup by default.
Our CockroachDB is configured with backup by default. This requires a Service Account to be configured, see <link to section below>

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cockroachdb/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

Post kustomize build diff:

diff --git a/root-manifests/cockroachdb/manifests/manifests.yaml b/built-manifests/cockroachdb/manifests-cfssl/manifests.yaml
similarity index 100%
rename from root-manifests/cockroachdb/manifests/manifests.yaml
rename to built-manifests/cockroachdb/manifests-cfssl/manifests.yaml

=============================================
k8s objects: 0 to add, 0 to destroy
0 changed hunks

Copy link

@sbuliarca sbuliarca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done!

@MarcinGinszt MarcinGinszt merged commit 22a52f5 into main Jul 31, 2024
2 checks passed
@MarcinGinszt MarcinGinszt deleted the DENA-600 branch July 31, 2024 07:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants