-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: DOC-461 Projects Refactor (#2519)
* docs: DOC-461 * chore: unlist k8s hub * Update docs/docs-content/tenant-settings/projects/projects.md * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * chore: improve harsh CLS * Apply suggestions from code review Co-authored-by: Lenny Chen <[email protected]> * chore: updated lanaguage --------- Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: Lenny Chen <[email protected]>
- Loading branch information
1 parent
94eb2ee
commit d19c2b2
Showing
18 changed files
with
190 additions
and
10 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"position": 80 | ||
} |
92 changes: 92 additions & 0 deletions
92
docs/docs-content/tenant-settings/projects/create-manage-projects.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
--- | ||
sidebar_label: "Create and Manage Projects" | ||
title: "Create and Manage Projects" | ||
description: "Learn how to create and manage projects in Palette." | ||
hide_table_of_contents: false | ||
sidebar_position: 10 | ||
tags: ["projects"] | ||
--- | ||
|
||
Tenant administrators can create and manage projects in Palette. A tenant administrator automatically has access to all | ||
projects within the tenant. You can associate users and teams with a project. Check out the | ||
[Project Association](../../user-management/project-association.md) page to learn more. | ||
|
||
## Create a Project | ||
|
||
Use the following steps to create a new project. | ||
|
||
### Prerequisites | ||
|
||
- Tenant admin access. | ||
|
||
### Enablement | ||
|
||
1. Log in to [Palette](https://console.spectrocloud.com). | ||
|
||
2. Click on the **drop-down Menu** at the top of the page and switch to **Tenant Admin** scope. | ||
|
||
3. Navigate to the left **Main Menu** and click on **Projects**. | ||
|
||
4. Select the **Create Project** button. | ||
|
||
5. Fill out the input fields to create a project. Refer to the table below for more information. | ||
|
||
| Field | Description | Required | | ||
| ----------- | ----------------------------------- | -------- | | ||
| Name | The name of the project. | Yes | | ||
| Description | A brief description of the project. | No | | ||
| Tags | Add tags to the project. | No | | ||
|
||
6. Click **Confirm** to create the project. | ||
|
||
### Validate | ||
|
||
1. Log in to [Palette](https://console.spectrocloud.com). | ||
|
||
2. Navigate to **Tenant Admin** and select **Projects**. | ||
|
||
Your newly created project is listed along with other existing projects. | ||
|
||
## Delete a Project | ||
|
||
You can remove projects by using the following steps. | ||
|
||
### Prerequisites | ||
|
||
- Tenant admin access. | ||
|
||
- No active clusters in the project. | ||
|
||
:::warning | ||
|
||
You can delete projects with force as long as there are no active clusters. Force deleting will eliminate all resources | ||
linked to the project, such as app profiles, cluster profiles, workspaces, audit logs, and custom project settings. | ||
However, if a project has active clusters, you must remove them first before deleting the project. | ||
|
||
::: | ||
|
||
### Remove Project | ||
|
||
1. Log in to [Palette](https://console.spectrocloud.com). | ||
|
||
2. Switch to **Tenant Admin** scope. | ||
|
||
3. Navigate to the left **Main Menu** and select **Projects**. | ||
|
||
4. Locate the project card for the project you want to remove. | ||
|
||
5. Click on the **three-dot Menu** and select **Delete**. | ||
|
||
6. A pop-up box will ask you to confirm the action. Confirm the deletion. | ||
|
||
### Validate | ||
|
||
1. Log in to [Palette](https://console.spectrocloud.com). | ||
|
||
2. Switch to **Tenant Admin** scope. | ||
|
||
3. Navigate to the left **Main Menu** and select **Tenant Admin**. | ||
|
||
4. From the **Tenant Settings Menu**, select **Projects** . | ||
|
||
The project you deleted is no longer displayed or available for interaction. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
sidebar_label: "Projects" | ||
title: "Projects" | ||
description: | ||
"Projects helps you organize the cluster resources into a logical grouping. Learn more about project and how to use | ||
them in Palette." | ||
hide_table_of_contents: false | ||
sidebar_position: 0 | ||
tags: ["projects"] | ||
--- | ||
|
||
A **Project** helps you organize and manage cluster resources. A tenant can have multiple projects. Projects are used to | ||
group resources and manage user access control through Role Based Access Control (RBAC). You can assign users and teams | ||
with specific roles to specific projects. | ||
|
||
For example, you can create a project for each team, or create a project for each infrastructure environment. The | ||
flexibility of projects allow you to organize resources in a way that makes sense for your organization. | ||
|
||
## Scope | ||
|
||
All resources created within a project are scoped to that project and only available to that project. | ||
|
||
:::info | ||
|
||
Resources created under the tenant scope are available to all projects. | ||
|
||
::: | ||
|
||
The following resources are scoped to a project by default: | ||
|
||
- Alerts | ||
- Application profiles | ||
- Backup locations | ||
- Cloud accounts | ||
- Clusters | ||
- Cluster groups | ||
- Cluster profiles | ||
- Macros | ||
- Platform settings | ||
- SSH keys | ||
- Workspaces | ||
|
||
## Project Dashboard | ||
|
||
When a user logs in to Palette, the [project dashboard](../../getting-started/dashboard.md) is displayed by default. The | ||
project dashboard displays a map containing all the clusters deployed in the project. A summary of the clusters deployed | ||
in the project, deleted, failed deployments, and the number of clusters pending an update is also displayed. | ||
|
||
![A view of a project dashboard](/tenant_settings-projects-dashboard.webp) | ||
|
||
## Project ID | ||
|
||
Each project is assigned a unique ID when it is created. The project ID is used to identify the project when making API | ||
requests. | ||
|
||
You can find the project ID in the top-right corner of the project dashboard. | ||
|
||
![A project ID highlighted in the project dashboard view](/tenant_settings-projects-projects-project_id.webp) | ||
|
||
## Resources | ||
|
||
- [Create a Project](./create-manage-projects.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file added
BIN
+22.9 KB
static/assets/docs/images/tenant_settings-projects-projects-project_id.webp
Binary file not shown.