pytorch-operator: Consolidate manifests (#323)

* manifests: Add base/overlays structure Signed-off-by: Yannis Zarkadas <[email protected]> * Edit docs and scripts to use new manifests Signed-off-by: Yannis Zarkadas <[email protected]> * Delete old manifests Signed-off-by: Yannis Zarkadas <[email protected]>
kubeflow · Mar 18, 2021 · 4aeb650 · 4aeb650
1 parent 147349e
commit 4aeb650
Show file tree

Hide file tree

Showing 23 changed files with 21 additions and 266 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 ## Overview
 
-This repository contains the specification and implementation of `PyTorchJob` custom resource definition. Using this custom resource, users can create and manage PyTorch jobs like other built-in resources in Kubernetes. See [CRD definition](https://github.com/kubeflow/pytorch-operator/blob/master/manifests/crd.yaml)
+This repository contains the specification and implementation of `PyTorchJob` custom resource definition. Using this custom resource, users can create and manage PyTorch jobs like other built-in resources in Kubernetes. See [CRD definition](https://github.com/kubeflow/pytorch-operator/blob/master/manifests/base/crd.yaml)
 
 ## Prerequisites
 

diff --git a/developer_guide.md b/developer_guide.md
@@ -55,7 +55,7 @@ export KUBEFLOW_NAMESPACE=$(your_namespace)
 After the cluster is up, the PyTorch Operator CRD should be created on the cluster.
 
 ```bash
-kubectl create -f ./manifests/crd.yaml
+kubectl create -f ./manifests/base/crd.yaml
 ```
 
 ### Run Operator

diff --git a/manifests/crd.yaml → manifests/base/crd.yaml b/manifests/crd.yaml → manifests/base/crd.yaml
diff --git a/manifests/deployment.yaml → manifests/base/deployment.yaml b/manifests/deployment.yaml → manifests/base/deployment.yaml
diff --git a/.../pytorch-operator/base/kustomization.yaml → manifests/base/kustomization.yaml b/.../pytorch-operator/base/kustomization.yaml → manifests/base/kustomization.yaml
@@ -2,14 +2,16 @@ apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 namespace: kubeflow
 resources:
-- cluster-role-binding.yaml
-- cluster-role.yaml
+- crd.yaml
+- rbac.yaml
 - deployment.yaml
-- service-account.yaml
 - service.yaml
+- user-clusterroles.yaml
 commonLabels:
+  app: pytorch-operator
   kustomize.component: pytorch-operator
+  app.kubernetes.io/component: pytorch
+  app.kubernetes.io/name: pytorch-operator
 images:
 - name: gcr.io/kubeflow-images-public/pytorch-operator
-  newName: gcr.io/kubeflow-images-public/pytorch-operator
   newTag: vmaster-g518f9c76
diff --git a/manifests/podgroup.yaml → manifests/base/podgroup.yaml b/manifests/podgroup.yaml → manifests/base/podgroup.yaml
diff --git a/manifests/rbac.yaml → manifests/base/rbac.yaml b/manifests/rbac.yaml → manifests/base/rbac.yaml
diff --git a/manifests/service.yaml → manifests/base/service.yaml b/manifests/service.yaml → manifests/base/service.yaml
diff --git a/...s/pytorch-operator/base/cluster-role.yaml → manifests/base/user-clusterroles.yaml b/...s/pytorch-operator/base/cluster-role.yaml → manifests/base/user-clusterroles.yaml
@@ -1,35 +1,3 @@
-apiVersion: rbac.authorization.k8s.io/v1beta1
-kind: ClusterRole
-metadata:
-  labels:
-    app: pytorch-operator
-  name: pytorch-operator
-rules:
-- apiGroups:
-  - kubeflow.org
-  resources:
-  - pytorchjobs
-  - pytorchjobs/status
-  - pytorchjobs/finalizers
-  verbs:
-  - '*'
-- apiGroups:
-  - apiextensions.k8s.io
-  resources:
-  - customresourcedefinitions
-  verbs:
-  - '*'
-- apiGroups:
-  - ""
-  resources:
-  - pods
-  - services
-  - endpoints
-  - events
-  verbs:
-  - '*'
----
-
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:

diff --git a/...r/overlays/application/kustomization.yaml → ...ests/overlays/kubeflow/kustomization.yaml b/...r/overlays/application/kustomization.yaml → ...ests/overlays/kubeflow/kustomization.yaml
@@ -1,9 +1,12 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
-bases:
+kind: Kustomization
+namespace: kubeflow
+resources:
 - ../../base
 commonLabels:
+  app: pytorch-operator
+  kustomize.component: pytorch-operator
   app.kubernetes.io/component: pytorch
   app.kubernetes.io/name: pytorch-operator
-kind: Kustomization
-resources:
-- application.yaml
+images:
+- name: gcr.io/kubeflow-images-public/pytorch-operator
diff --git a/manifests/kustomization.yaml → ...ts/overlays/standalone/kustomization.yaml b/manifests/kustomization.yaml → ...ts/overlays/standalone/kustomization.yaml
@@ -2,14 +2,12 @@ apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 namespace: kubeflow
 resources:
-- crd.yaml
+- ../../base
 - namespace.yaml
-- rbac.yaml
-- deployment.yaml
-- service.yaml
 commonLabels:
+  app: pytorch-operator
   kustomize.component: pytorch-operator
+  app.kubernetes.io/component: pytorch
+  app.kubernetes.io/name: pytorch-operator
 images:
 - name: gcr.io/kubeflow-images-public/pytorch-operator
-  newName: 809251082950.dkr.ecr.us-west-2.amazonaws.com/pytorch-operator
-  newTag: "0.1"
diff --git a/manifests/namespace.yaml → manifests/overlays/standalone/namespace.yaml b/manifests/namespace.yaml → manifests/overlays/standalone/namespace.yaml
diff --git a/manifests/pytorch-job-crds/base/crd.yaml b/manifests/pytorch-job-crds/base/crd.yaml
diff --git a/manifests/pytorch-job-crds/base/kustomization.yaml b/manifests/pytorch-job-crds/base/kustomization.yaml
diff --git a/manifests/pytorch-job-crds/overlays/application/application.yaml b/manifests/pytorch-job-crds/overlays/application/application.yaml
diff --git a/manifests/pytorch-job-crds/overlays/application/kustomization.yaml b/manifests/pytorch-job-crds/overlays/application/kustomization.yaml
diff --git a/manifests/pytorch-operator/base/cluster-role-binding.yaml b/manifests/pytorch-operator/base/cluster-role-binding.yaml
diff --git a/manifests/pytorch-operator/base/deployment.yaml b/manifests/pytorch-operator/base/deployment.yaml
diff --git a/manifests/pytorch-operator/base/params.env b/manifests/pytorch-operator/base/params.env
diff --git a/manifests/pytorch-operator/base/service-account.yaml b/manifests/pytorch-operator/base/service-account.yaml
diff --git a/manifests/pytorch-operator/base/service.yaml b/manifests/pytorch-operator/base/service.yaml
diff --git a/manifests/pytorch-operator/overlays/application/application.yaml b/manifests/pytorch-operator/overlays/application/application.yaml
diff --git a/scripts/setup-pytorch-operator.sh b/scripts/setup-pytorch-operator.sh
@@ -33,11 +33,11 @@ aws eks update-kubeconfig --region=${REGION} --name=${CLUSTER_NAME}
 
 echo "Update PyTorch operator manifest with new name and tag"
 #TODO(Jeffwan@): If there's a way to specify context, then we don't need to enter manifests folder
-cd manifests/
+cd manifests/overlays/standalone
 kustomize edit set image gcr.io/kubeflow-images-public/pytorch-operator=${REGISTRY}/${REPO_NAME}:${VERSION}
 
 echo "Installing PyTorch operator manifests"
-kubectl apply -k .
+kustomize build . | kubectl apply -f -
 
 TIMEOUT=30
 until kubectl get pods -n kubeflow | grep pytorch-operator | grep 1/1 || [[ $TIMEOUT -eq 1 ]]; do