Documentation: Improve documentation by adding more details
vlours opened this issue · 5 comments
I was following the GCP documentation trying to Install an OpenShift Cluster with GCP Workload Identity.
I noticed that some of the steps are not well described and need to be reviewed:
-
RELEASE_IMAGE => this variable is noted, but not described. Sharing an example, and suggesting checking the release tags from quay.io should help the user to understand it.
-
ccoctl the command used to describe the syntax is almost correct but can be even better if you use some example to describe it. Furthermore, I've raised Issue #451 to address the confusing sentence to confirm the JSON .
You should be able to explain it like this (placing this step before theopenshift-installer create manifests:
INSTALL_CONFIG_FILE=install-config.yaml
CCO_NAME=$(yq -r '.metadata.name' ${INSTALL_CONFIG_FILE}); CCO_REGION=$(yq -r '.platform.gcp.region' ${INSTALL_CONFIG_FILE}); CCO_PROJECT=$(yq -r '.platform.gcp.projectID' ${INSTALL_CONFIG_FILE})
- Also, the ccoctl is not macOS friendly, where the openshift-installer is, and the documentation should provide a way to do it.
I managed to run it into a docker container on my laptop. Here is my command:
# Variables need to be set from the install_config file as described previously
# Copy the osServiceAccount.json into your Install_dir
cp ~/Download/osServiceAccount.json /full/path/to/your/install_dir/
# Use docker to run ccoctl into an ubi8 image
$ docker run --rm -ti -v /full/path/to/your/install_dir:/mnt redhat/ubi8-minimal /mnt/ccoctl gcp create-all --name=${CCO_NAME} --region=${CCO_REGION} --project=${CCO_PROJECT} --credentials-requests-dir=./mnt/credreqs --output-dir=/mnt/cco_output
And to delete the cco:
docker run --rm -ti -v /full/path/to/your/install_dir:/mnt redhat/ubi8-minimal /mnt/ccoctl gcp delete --name=${CCO_NAME} --project=${CCO_PROJECT}
Otherwise, the rest of the documentation is OK.
Issues go stale after 90d of inactivity.
Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.
If this issue is safe to close now please do so with /close.
/lifecycle stale
Stale issues rot after 30d of inactivity.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.
If this issue is safe to close now please do so with /close.
/lifecycle rotten
/remove-lifecycle stale
Issues go stale after 90d of inactivity.
Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.
If this issue is safe to close now please do so with /close.
/lifecycle stale