Feedback: Deploy CockroachDB with the CockroachDB Operator

Open Beginner friendly
#23,078 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
google-cloud, kubernetes
Domain
cloud, documentation

Research direction

Open the “Deploy CockroachDB with the CockroachDB Operator” guide and review its Values configuration and client-secure pod command sections. Correct the resource path to the CRD schema and add the namespace flag to the kubectl commands; done means the documented commands work in the target namespace without the reported schema or ServiceAccount errors.

Written by the indexing model from the issue text.

Description

Page: https://cockroachlabs.com/docs/v26.1/deploy-cockroachdb-with-cockroachdb-operator.html

What is the reason for your feedback?

[ ] Missing the information I need

[ ] Too complicated

[ ] Out of date

[x] Something is broken

[ ] Other

Additional details

Issues encountered following the "Deploy CockroachDB with the CockroachDB Operator" guide on a GKE regional cluster (v1.34, e2-standard-4 x 3 zones):

  1. Incorrect resource configuration path (Values documentation)
    The documentation references cockroachdb.crdbCluster.podTemplate.spec.resources for setting CPU/memory, but the correct path in the CRD schema is cockroachdb.crdbCluster.podTemplate.spec.containers[].resources. Using the documented path causes: spec.template.spec.podTemplate.spec.resources: field not declared in schema.

  2. Missing -n in client-secure pod commands
    The document does not specify the namespace flag when running:

    • kubectl create -f client-secure.yaml
    • kubectl exec -it cockroachdb-client-secure -- ...

    Without -n , the pod is created in the default namespace where the cockroachdb ServiceAccount doesn't exist, resulting in: error looking up service account default/cockroachdb: serviceaccount "cockroachdb" not found.

Jira issue: DOC-16325

Dominant language
HTML
Stars
212
Forks
477
Avg merge
40m
Merged PRs (30d)
3

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cockroachdb/docs

All issues in cockroachdb/docs

Similar issues

More Cloud issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.