From 6fc757d01b95f25e4561312d65fe0a35a26aa2d4 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Tue, 21 Nov 2023 13:22:47 -0800 Subject: [PATCH 1/4] Add Projects API workflow example --- .../version-2.8/api/workflows/projects.md | 109 ++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 versioned_docs/version-2.8/api/workflows/projects.md diff --git a/versioned_docs/version-2.8/api/workflows/projects.md b/versioned_docs/version-2.8/api/workflows/projects.md new file mode 100644 index 00000000000..9af2f25cbe9 --- /dev/null +++ b/versioned_docs/version-2.8/api/workflows/projects.md @@ -0,0 +1,109 @@ +--- +title: Projects +--- + +## Creating a Project + +Project resources may only be created on the management cluster. See below for [creating namespaces under projects in a managed cluster](#creating-a-namespace-in-a-project). + +### Creating a Basic Project + +```bash +kubectl create -f - <:`. + +## Deleting a Project + +Look up the project to delete in the cluster namespace since it generated using `metadata.generateName`: + +```bash +kubectl --namespace c-m-abcde get projects +``` + +Delete the project under the cluster namespace: + +```bash +kubectl --namespace c-m-abcde delete project p-vwxyz +``` From f28cb43e678d4b5ff7c4d9d42ab1f10b2d06adf8 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Tue, 21 Nov 2023 13:27:43 -0800 Subject: [PATCH 2/4] Add project workflow to sidebar; remove duplicate API category --- versioned_sidebars/version-2.8-sidebars.json | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/versioned_sidebars/version-2.8-sidebars.json b/versioned_sidebars/version-2.8-sidebars.json index 0e0f3c923c8..d29e846ed9a 100644 --- a/versioned_sidebars/version-2.8-sidebars.json +++ b/versioned_sidebars/version-2.8-sidebars.json @@ -1311,17 +1311,15 @@ "items": [ "api/quickstart", { - - } - ] - }, - "contribute-to-rancher", - { - "type": "category", - "label": "API", - "items": [ + "type": "category", + "label": "Example Workflows", + "items": [ + "api/workflows/projects" + ] + }, "api/api-reference" ] - } + }, + "contribute-to-rancher" ] } From 284b6ddb9068fb693ebaa937c2fa3f3cdd7ae5d3 Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Tue, 21 Nov 2023 14:27:41 -0800 Subject: [PATCH 3/4] Update versioned_docs/version-2.8/api/workflows/projects.md Co-authored-by: Marty Hernandez Avedon --- versioned_docs/version-2.8/api/workflows/projects.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-2.8/api/workflows/projects.md b/versioned_docs/version-2.8/api/workflows/projects.md index 9af2f25cbe9..3fce9dfa753 100644 --- a/versioned_docs/version-2.8/api/workflows/projects.md +++ b/versioned_docs/version-2.8/api/workflows/projects.md @@ -25,7 +25,7 @@ Use `metadata.generateName` to ensure a unique project ID, but note that `kubect Set `metadata.namespace` and `spec.clusterName` to the ID for the cluster the project belongs to. -### Creating a Project With Resource Quota +### Creating a Project With a Resource Quota Refer to [Kubernetes Resource Quota](https://kubernetes.io/docs/concepts/policy/resource-quotas/). From e76ed17b4da8140dee40b921f1b866b0cee850ab Mon Sep 17 00:00:00 2001 From: Billy Tat Date: Wed, 22 Nov 2023 11:55:24 -0800 Subject: [PATCH 4/4] Update versioned_docs/version-2.8/api/workflows/projects.md --- versioned_docs/version-2.8/api/workflows/projects.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-2.8/api/workflows/projects.md b/versioned_docs/version-2.8/api/workflows/projects.md index 3fce9dfa753..ddc2f8c5aae 100644 --- a/versioned_docs/version-2.8/api/workflows/projects.md +++ b/versioned_docs/version-2.8/api/workflows/projects.md @@ -96,7 +96,7 @@ Note the format, `:`. ## Deleting a Project -Look up the project to delete in the cluster namespace since it generated using `metadata.generateName`: +Look up the project to delete in the cluster namespace: ```bash kubectl --namespace c-m-abcde get projects