Extend Katib documentation to use not in GKE #2260
Conversation
|
/lgtm |
|
@jlewi @YujiOshima |
kubeflow/katib/README.md
Outdated
| @@ -16,27 +16,28 @@ | |||
|
|
|||
| ## Quickstart | |||
|
|
|||
| For running Katib you have to install tf-job operator and pytorch operator package. | |||
| For running Katib, you have to install tfjob operator and pytorch operator package. | |||
There was a problem hiding this comment.
Maybe just say TF operator to be consistent with the repo name.
kubeflow/katib/README.md
Outdated
| ks registry add kubeflow github.com/kubeflow/kubeflow/tree/master/kubeflow | ||
| ``` | ||
|
|
||
| ### TF-job operator | ||
| ### TFjob operator |
There was a problem hiding this comment.
Same here - TF operator
kubeflow/katib/README.md
Outdated
| @@ -55,6 +56,33 @@ ks generate katib katib | |||
| ks apply ${KF_ENV} -c katib | |||
| ``` | |||
|
|
|||
| If you want to use Katib not in GKE and you don't have StorageClass for dynamic volume provisioning at your cluster, you have to create persistent volume to bound your persistent volume claim. | |||
There was a problem hiding this comment.
Include a link to k8s documentation: https://kubernetes.io/docs/concepts/storage/persistent-volumes/
| @@ -65,5 +93,11 @@ ks delete ${KF_ENV} -c pytorch-operator | |||
| ks delete ${KF_ENV} -c tf-job-operator | |||
| ``` | |||
|
|
|||
| If you create pv for Katib, delete it | |||
There was a problem hiding this comment.
Need to delete the pvc as well?
There was a problem hiding this comment.
@richardsliu Thank you for your review!
PVC will be deleted by this command
ks delete ${KF_ENV} -c katib.
Katib package includes PVC.
Add doc link for Persistent Volume
|
/assign @richardsliu @richardsliu @johnugeorge Is the PR ready to merge? If so you can lgtm and approve it please? |
|
/lgtm |
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: richardsliu The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
* Add deploying Katib not in GKE in README * Fix context * Add context * Move section for using Katib not in GKE * Fix README * Fix README * Change name for TF operator Add doc link for Persistent Volume
* Add deploying Katib not in GKE in README * Fix context * Add context * Move section for using Katib not in GKE * Fix README * Fix README * Change name for TF operator Add doc link for Persistent Volume
I added some information inside Katib package README.
How to deploy Katib not in GKE if you don't have StorageClass inside your cluster.
This change is