[Misc] Improve the installation component sequence

.github/workflows/installation-tests.yml

@@ -55,7 +55,7 @@ jobs:
           cd ${{ github.workspace }}
           cd config/gateway && kustomize edit set image plugins=aibrix/plugins:${{ github.sha }} && kustomize edit set image users=aibrix/users:${{ github.sha }}
           cd ${{ github.workspace }}
-          kubectl apply -k config/default
+          kubectl create -k config/default
 
       - name: Check pod status
         run: |

README.md

@@ -28,7 +28,7 @@ cd aibrix
 kubectl create -k config/dependency
 
 # Install aibrix components
-kubectl apply -k config/default
+kubectl create -k config/default
 ```
 
 Install stable distribution
@@ -37,7 +37,7 @@ Install stable distribution
 kubectl create -k "github.com/aibrix/aibrix/config/dependency?ref=v0.1.0-rc.1"
 
 # Install aibrix components
-kubectl apply -k "github.com/aibrix/aibrix/config/default?ref=v0.1.0-rc.1"
+kubectl create -k "github.com/aibrix/aibrix/config/default?ref=v0.1.0-rc.1"
 ```
 
 ## Documentation

config/default/kustomization.yaml

@@ -19,6 +19,7 @@ resources:
 - ../rbac
 - ../manager
 - ../gateway
+- ../dependency/kuberay-operator
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix including the one in
 # crd/kustomization.yaml
 #- ../webhook

config/dependency/kuberay-operator/README.md

@@ -0,0 +1,9 @@
+## KubeRay upstream manifests
+
+Commands to export manifest from helm package. After you got manifest, copy to this folder.
+
+```shell
+helm template kuberay-operator kuberay/kuberay-operator --namespace aibrix-system --version 1.2.1 --include-crds --set env[0].name=ENABLE_PROBES_INJECTION --set env[0].value=\"false\" --set fullnameOverride=kuberay-operator --output-dir ./config/dependency
+```
+
+If you use zsh, please use `noglob helm ...` to skip the brace check.

config/dependency/kuberay/kustomization.yaml → config/dependency/kuberay-operator/kustomization.yaml

@@ -2,7 +2,6 @@ kind: Kustomization
 
 # KubeRay helm package doesn't allow namespace setting at this moment, we can not export resources with namespace specified
 # The workaround is to use kustomize namespace override to create under aibrix-system namespace.
-namespace: aibrix-system
 
 resources:
 - crds/ray.io_rayclusters.yaml

config/dependency/kuberay/templates/deployment.yaml → config/dependency/kuberay-operator/templates/deployment.yaml

@@ -3,11 +3,11 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: aibrix-kuberay-operator
+  name: kuberay-operator
   labels:
     app.kubernetes.io/name: kuberay-operator
     helm.sh/chart: kuberay-operator-1.2.1
-    app.kubernetes.io/instance: aibrix-kuberay-operator
+    app.kubernetes.io/instance: kuberay-operator
     app.kubernetes.io/managed-by: Helm
 spec:
   replicas: 1
@@ -16,12 +16,12 @@ spec:
   selector:
     matchLabels:
       app.kubernetes.io/name: kuberay-operator
-      app.kubernetes.io/instance: aibrix-kuberay-operator
+      app.kubernetes.io/instance: kuberay-operator
   template:
     metadata:
       labels:
         app.kubernetes.io/name: kuberay-operator
-        app.kubernetes.io/instance: aibrix-kuberay-operator
+        app.kubernetes.io/instance: kuberay-operator
         app.kubernetes.io/component: kuberay-operator
     spec:
       serviceAccountName: kuberay-operator

config/dependency/kuberay/templates/leader_election_role.yaml → config/dependency/kuberay-operator/templates/leader_election_role.yaml

@@ -6,9 +6,9 @@ metadata:
   labels: 
     app.kubernetes.io/name: kuberay-operator
     helm.sh/chart: kuberay-operator-1.2.1
-    app.kubernetes.io/instance: aibrix-kuberay-operator
+    app.kubernetes.io/instance: kuberay-operator
     app.kubernetes.io/managed-by: Helm
-  name: aibrix-kuberay-operator-leader-election
+  name: kuberay-operator-leader-election
 rules:
 - apiGroups:
   - ""

config/dependency/kuberay/templates/leader_election_role_binding.yaml → config/dependency/kuberay-operator/templates/leader_election_role_binding.yaml

@@ -6,14 +6,14 @@ metadata:
   labels: 
     app.kubernetes.io/name: kuberay-operator
     helm.sh/chart: kuberay-operator-1.2.1
-    app.kubernetes.io/instance: aibrix-kuberay-operator
+    app.kubernetes.io/instance: kuberay-operator
     app.kubernetes.io/managed-by: Helm
-  name: aibrix-kuberay-operator-leader-election
+  name: kuberay-operator-leader-election
 subjects:
 - kind: ServiceAccount
   name: kuberay-operator
   namespace: aibrix-system
 roleRef:
   kind: Role
-  name: aibrix-kuberay-operator-leader-election
+  name: kuberay-operator-leader-election
   apiGroup: rbac.authorization.k8s.io

config/dependency/kuberay/templates/ray_rayjob_editor_role.yaml → config/dependency/kuberay-operator/templates/ray_rayjob_editor_role.yaml

@@ -8,7 +8,7 @@ metadata:
   labels: 
     app.kubernetes.io/name: kuberay-operator
     helm.sh/chart: kuberay-operator-1.2.1
-    app.kubernetes.io/instance: aibrix-kuberay-operator
+    app.kubernetes.io/instance: kuberay-operator
     app.kubernetes.io/managed-by: Helm
   name: rayjob-editor-role
 rules:

config/dependency/kuberay/templates/ray_rayjob_viewer_role.yaml → config/dependency/kuberay-operator/templates/ray_rayjob_viewer_role.yaml

@@ -8,7 +8,7 @@ metadata:
   labels: 
     app.kubernetes.io/name: kuberay-operator
     helm.sh/chart: kuberay-operator-1.2.1
-    app.kubernetes.io/instance: aibrix-kuberay-operator
+    app.kubernetes.io/instance: kuberay-operator
     app.kubernetes.io/managed-by: Helm
   name: rayjob-viewer-role
 rules:

config/dependency/kuberay/templates/role.yaml → config/dependency/kuberay-operator/templates/role.yaml

@@ -6,9 +6,9 @@ metadata:
   labels:
     app.kubernetes.io/name: kuberay-operator
     helm.sh/chart: kuberay-operator-1.2.1
-    app.kubernetes.io/instance: aibrix-kuberay-operator
+    app.kubernetes.io/instance: kuberay-operator
     app.kubernetes.io/managed-by: Helm
-  name: aibrix-kuberay-operator
+  name: kuberay-operator
 rules:
 - apiGroups:
   - batch

config/dependency/kuberay/templates/rolebinding.yaml → config/dependency/kuberay-operator/templates/rolebinding.yaml

@@ -6,14 +6,14 @@ metadata:
   labels:
     app.kubernetes.io/name: kuberay-operator
     helm.sh/chart: kuberay-operator-1.2.1
-    app.kubernetes.io/instance: aibrix-kuberay-operator
+    app.kubernetes.io/instance: kuberay-operator
     app.kubernetes.io/managed-by: Helm
-  name: aibrix-kuberay-operator
+  name: kuberay-operator
 subjects:
 - kind: ServiceAccount
   name: kuberay-operator
   namespace: aibrix-system
 roleRef:
   kind: ClusterRole
-  name: aibrix-kuberay-operator
+  name: kuberay-operator
   apiGroup: rbac.authorization.k8s.io

config/dependency/kuberay/templates/service.yaml → config/dependency/kuberay-operator/templates/service.yaml

@@ -3,11 +3,11 @@
 apiVersion: v1
 kind: Service
 metadata:
-  name: aibrix-kuberay-operator
+  name: kuberay-operator
   labels:
     app.kubernetes.io/name: kuberay-operator
     helm.sh/chart: kuberay-operator-1.2.1
-    app.kubernetes.io/instance: aibrix-kuberay-operator
+    app.kubernetes.io/instance: kuberay-operator
     app.kubernetes.io/managed-by: Helm
 spec:
   type: ClusterIP
@@ -18,4 +18,4 @@ spec:
       name: http
   selector:
     app.kubernetes.io/name: kuberay-operator
-    app.kubernetes.io/instance: aibrix-kuberay-operator
+    app.kubernetes.io/instance: kuberay-operator

config/dependency/kuberay/templates/serviceaccount.yaml → config/dependency/kuberay-operator/templates/serviceaccount.yaml

@@ -7,5 +7,5 @@ metadata:
   labels:
     app.kubernetes.io/name: kuberay-operator
     helm.sh/chart: kuberay-operator-1.2.1
-    app.kubernetes.io/instance: aibrix-kuberay-operator
+    app.kubernetes.io/instance: kuberay-operator
     app.kubernetes.io/managed-by: Helm

config/dependency/kustomization.yaml

@@ -1,6 +1,4 @@
 kind: Kustomization
 
 resources:
-- namespace.yaml
 - envoy-gateway
-- kuberay

config/rbac/leader_election_role.yaml

@@ -5,7 +5,7 @@ metadata:
   labels:
     app.kubernetes.io/name: aibrix
     app.kubernetes.io/managed-by: kustomize
-  name: leader-election-role
+  name: controller-manager-leader-election-role
 rules:
 - apiGroups:
   - ""

config/rbac/leader_election_role_binding.yaml

@@ -4,11 +4,11 @@ metadata:
   labels:
     app.kubernetes.io/name: aibrix
     app.kubernetes.io/managed-by: kustomize
-  name: leader-election-rolebinding
+  name: controller-manager-leader-election-rolebinding
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: Role
-  name: leader-election-role
+  name: controller-manager-leader-election-role
 subjects:
 - kind: ServiceAccount
   name: controller-manager

config/rbac/role.yaml

@@ -2,7 +2,7 @@
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
-  name: manager-role
+  name: controller-manager-role
 rules:
 - apiGroups:
   - ""

config/rbac/role_binding.yaml

@@ -4,11 +4,11 @@ metadata:
   labels:
     app.kubernetes.io/name: aibrix
     app.kubernetes.io/managed-by: kustomize
-  name: manager-rolebinding
+  name: controller-manager-rolebinding
 roleRef:
   apiGroup: rbac.authorization.k8s.io
   kind: ClusterRole
-  name: manager-role
+  name: controller-manager-role
 subjects:
 - kind: ServiceAccount
   name: controller-manager

docs/source/getting_started/faq.rst

@@ -0,0 +1,24 @@
+.. _faq:
+
+===
+FAQ
+===
+
+FAQ - Installation
+------------------
+
+Failed to delete the AIBrix
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. figure:: ../assets/images/delete-namespace-stuck-1.png
+  :alt: aibrix-architecture-v1
+  :width: 70%
+  :align: center
+
+.. figure:: ../assets/images/delete-namespace-stuck-2.png
+  :alt: aibrix-architecture-v1
+  :width: 70%
+  :align: center
+
+In this case, you just need to find the model adapter, edit the object, and remove the ``finalizer`` pair. the pod would be deleted automatically.
+

docs/source/getting_started/installation.rst

@@ -39,7 +39,7 @@ Nightly Version
     kubectl create -k config/dependency
 
     # Install aibrix components
-    kubectl apply -k config/default
+    kubectl create -k config/default
 
 
 Install AIBrix on Kind Cluster

docs/source/index.rst

@@ -29,6 +29,7 @@ Documentation
    designs/architecture.rst
    getting_started/quickstart.rst
    getting_started/installation.rst
+   getting_started/faq.rst
 
 .. toctree::
    :maxdepth: 1

pkg/controller/rayclusterfleet/suite_test.go

@@ -57,7 +57,7 @@ var _ = BeforeSuite(func() {
 	testEnv = &envtest.Environment{
 		CRDDirectoryPaths: []string{
 			filepath.Join("..", "..", "..", "config", "crd", "bases"),
-			filepath.Join("..", "..", "..", "config", "dependency", "kuberay", "crds", "ray.io_rayclusters.yaml"),
+			filepath.Join("..", "..", "..", "config", "dependency", "kuberay-operator", "crds", "ray.io_rayclusters.yaml"),
 		},
 		ErrorIfCRDPathMissing: true,
 

pkg/controller/rayclusterreplicaset/suite_test.go

@@ -57,7 +57,7 @@ var _ = BeforeSuite(func() {
 	testEnv = &envtest.Environment{
 		CRDDirectoryPaths: []string{
 			filepath.Join("..", "..", "..", "config", "crd", "bases"),
-			filepath.Join("..", "..", "..", "config", "dependency", "kuberay", "crds", "ray.io_rayclusters.yaml"),
+			filepath.Join("..", "..", "..", "config", "dependency", "kuberay-operator", "crds", "ray.io_rayclusters.yaml"),
 		},
 		ErrorIfCRDPathMissing: true,