diff --git a/docs/api/workflows/projects.md b/docs/api/workflows/projects.md index 853dd7f164b..a3678d8addc 100644 --- a/docs/api/workflows/projects.md +++ b/docs/api/workflows/projects.md @@ -25,11 +25,15 @@ spec: EOF ``` -Use `metadata.generateName` to ensure a unique project ID, but note that `kubectl apply` does not work with `metadata.generateName`, so `kubectl create` must be used instead. +When creating a new project, you have two primary options for setting the name: + +- **Automatic Generation:** Use `metadata.generateName` to ensure a unique project ID. However, note that you must use `kubectl create` (instead of `kubectl apply`) with this option, as `kubectl apply` does not support it. +- **Manual Naming:** You can explicitly set the project ID using `metadata.name`. If a project with that exact name already exists, the name request is denied. +The display name seen in the UI is set by `spec.displayName`. If `spec.displayName` is not provided, the field `metadata.name` is used instead. Set `metadata.namespace` and `spec.clusterName` to the ID for the cluster the project belongs to. -If you create a project through a cluster member account, you must include the annotation, `field.cattle.io/creatorId`, and set it to the cluster member account's user ID. +If you create a project through a cluster member account and want that account to be able to access the project, you must include the annotation `field.cattle.io/creatorId`, and set it to the cluster member account's user ID. ```bash kubectl create -f - <