-
Task
-
Resolution: Done
-
Blocker
-
None
-
None
-
8
-
False
-
-
False
-
ToDo
-
-
-
Sprint 18-MMSDOCS 2024, Sprint 19-MMSDOCS 2024
-
2
-
0
-
0.000
-
Very Likely
-
0
-
None
-
Unset
-
Unknown
-
None
oadp-dev slack
forum-ocp-etcd slack
There is another conflicting backup api shortname from OpenShift from etcd team
https://github.com/openshift/api/commits/master/config/v1alpha1/types_backup.go
Our docs always reference oc get backup. This will break if customers have ocp-etcd backup api which I'm guessing will come as part of GA of OCPSTRAT-1244
We need to refactor our docs to avoid shortname conflicting with etcd team. This also follows best practices: https://kubernetes.io/docs/reference/kubectl/conventions/#using-kubectl-in-reusable-scripts
It is clear from github search that majority of oc get backups existing today are for oadp-operator's velero. Most of which are already in customer/partner scripts and/or documentation as well.
Todo for OADP Docs team
- replace all command line callouts that are
oc <verb> <backup|restore|backupstoragelocation|bsl|backuprepositories>
with
oc <verb> <backups|restores|backupstoragelocations|backuprepositories>.velero.io
Below is everything we should ideally use fullname for
❯ oc api-resources -oname | grep -E 'velero.io|oadp'
nonadminbackups.nac.oadp.openshift.io
cloudstorages.oadp.openshift.io
dataprotectionapplications.oadp.openshift.io
backuprepositories.velero.io
backups.velero.io
backupstoragelocations.velero.io
datadownloads.velero.io
datauploads.velero.io
deletebackuprequests.velero.io
downloadrequests.velero.io
podvolumebackups.velero.io
podvolumerestores.velero.io
restores.velero.io
schedules.velero.io
serverstatusrequests.velero.io
volumesnapshotlocations.velero.io
openshift-docs needing updating: https://github.com/search?q=org%3Aopenshift+%2Foc+%5Ba-z%5D%2B+%28backup%7Crestore%7Cbackupstoragelocation%7Cbsl%7Cbackuprepositories%29+%2F+repo%3Aopenshift%2Fopenshift-docs+NOT+%22etcd+backup%22&type=code
These are all items in openshift org excluding openshift-docs
https://github.com/search?q=org%3Aopenshift+%2Foc+%5Ba-z%5D%2B+%28backup%7Crestore%7Cbackupstoragelocation%7Cbsl%7Cbackuprepositories%29+%2F+NOT+%28repo%3Aopenshift%2Fopenshift-docs+OR+%22etcd+backup%22%29&type=code
Todo for etcd team is
- replace instances of api shortname
oc get crd | grep backup
like here with
oc get crd | grep -E "backups.config.openshift.io|etcdbackups.operator.openshift.io"