cloudnative-pg / cloudnative-pg/cloudnative-pg
[Docs]: kubectl cnpg <> --help output
- Dominant language
- Go
- Stars
- 9.3k
- Forks
- 759
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 44
Description
### Is there an existing issue already for your request/idea?
- [x] I have searched for an existing issue, and could not find anything. I believe this is a new documentation enhancement to be evaluated.
### What problem in the existing documentation this issue aims to solve?
Hi, Team !
I have discovered the following typos for the latest version of CNPG plugin (1.29.1).
0)
```
[alexey@wsl2 ~]$ kubectl cnpg version
Build: {Version:1.29.1 Commit:a4060c152 Date:2026-05-08}
```
1)
```
[alexey@wsl2 ~]$ k cnpg pgadmin4 --help
Creates a pgAdmin deployment configured to work with a CNPG Cluster.
Usage:
kubectl cnpg pgadmin4 [name] [flags]
Examples:
# Dry-run command with default values"
kubectl-cnpg pgadmin --dry-run
# Create a pgadmin job with default values.
kubectl-cnpg pgadmin
# Dry-run command with given values and clusterName "cluster-example"
kubectl-cnpg pgadmin cluster-example -n --dry-run
...
```
Pls. replace the occurrences of 'kubectl-cnpg' with 'kubectl cnpg' and 'pgadmin' with 'pgadmin4'.
2)
```
[alexey@wsl2 ~]$ k cnpg fio --help
Creates a fio deployment that will execute a fio job on the specified pvc.
Usage:
kubectl cnpg fio [name] [flags]
Examples:
# Dry-run command with default values"
kubectl-cnpg fio --dry-run
# Create a fio job with default values.
kubectl-cnpg fio
# Dry-run command with given values and clusterName "cluster-example"
kubectl-cnpg fio -n --storageClass --pvcSize --dry-run
# Create a job with given values and clusterName "cluster-example"
kubectl-cnpg fio -n --storageClass --pvcSize
...
```
Pls. replace the occurrences of 'kubectl-cnpg' with 'kubectl cnpg'.
3)
```
[alexey@wsl2 ~]$ k cnpg pgbench --help
Creates a pgbench job to run against the specified Postgres Cluster.
Usage:
kubectl cnpg pgbench CLUSTER [-- PGBENCH_COMMAND_ARGS...] [flags]
Examples:
# Dry-run command with default values and [cluster] "cluster-example"
kubectl-cnpg pgbench cluster-example --dry-run
# Create a pgbench job with default values and [cluster] "cluster-example"
kubectl-cnpg pgbench cluster-example
# Dry-run command with given values and [cluster] "cluster-example"
kubectl-cnpg pgbench cluster-example --db-name pgbenchDBName --job-name job-name --dry-run -- \
--time 30 --client 1 --jobs 1
# Create a job with given values and [cluster] "cluster-example"
kubectl-cnpg pgbench cluster-example --db-name pgbenchDBName --job-name job-name -- \
--time 30 --client 1 --jobs 1
# Create a job with given values on [cluster] "cluster-example". The job will be cleaned after 10 minutes.
kubectl-cnpg pgbench cluster-example --db-name pgbenchDBName --job-name job-name --ttl 600 -- \
--time 30 --client 1 --jobs 1
...
```
Pls. replace the occurrences of 'kubectl-cnpg' with 'kubectl cnpg'.
### Describe what additions need to be done to the documentation
_No response_
### Describe what pages need to change in the documentation, if any
_No response_
### Describe what pages need to be removed from the documentation, if any
_No response_
### Additional context
_No response_
### Backport?
Yes
### Code of Conduct
- [x] I agree to follow this project's Code of Conduct
Contributor guide
Assessment
This issue has not been assessed yet.