Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Task] Add updates for quota crud feature mto docs SA 6918 #264

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions content/how-to-guides/crud/quota-crud-workflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Quota

## Create

## Overview

The quota creation process allows administrators to define resource limits and optional configurations for containers and pods. This document outlines the steps to create a new quota, including the metadata, resource quota, and limit range configurations.

### Step 1: Metadata

![quotaCreationMetadata](../../images/quotaCreationMetadata.png)

- Name Field
- The name field is mandatory and must be unique.
- If the name already exists, an inline error message is displayed.

- Error Handling
- Regex Validation
- The quota name must conform to the following regex pattern:

```regex
/^[a-z0-9]+(-[a-z0-9]+)*$/
```

- This ensures that quota names consist of lowercase alphanumeric characters and hyphens, and do not start or end with a hyphen.
- The metadata section in the drawer while creating a quota is to provide a name for the quota. Users must ensure the quota name meets the specified
criteria. Also, the quota name should not already exist in order to create a new quota.

### Step 2: Resource Quota

![quotaCreationResourceQuota](../../images/quotaCreationResourceQuota.png)

1. Adding Resources
- The **Resource** dropdown allows the selection of resource types such as:
- CPU Requests
- Memory Requests
- Config Maps
- Secrets
- Services
- Load Balancer Services
- Enter the corresponding **Value** for the selected resource.

1. Error Handling
- If an invalid format is entered in the **Value** field, an inline error message is displayed.

1. Add Resource Button:
- Allows users to add multiple resources sequentially.

### Step 3: Limit Range (Optional)

![quotaCreationLimitRange](../../images/quotaCreationLimitRange.png)

The limit range section provides optional configurations for containers and pods. It includes:

1. Container
- Configure limits for container resources by entering:
- **Min** and **Max** values for resource types.
- **Default Request** and **Default Limit** values.

1. Pod
- Similar to the container section, allows configuration for pod-level resources.

1. Error Handling
- No validation errors occur unless an invalid value is entered.
- Inline errors guide users in correcting their inputs.

### Final Step: Save Quota

1. Add Quota Button
- Once all configurations are completed, users can click the **Add Quota** button to save the quota.

1. Completion
- The system validates all input fields before saving.
- A confirmation message is displayed once the quota is successfully created.

### Notes

- The entire quota creation process is intuitive, with inline validation to guide users.
- Optional configurations like "Limit Range" allow flexibility based on use cases.

## Update

User can click on the edit button in the table under the action items to open the drawer with all the pre-populated quota configurations.

The update process follows a similar flow to the create process. However, the key difference is that the **quota name** in **Step-1** cannot be edited or updated. All other steps and configurations remain the same, allowing users to modify resource quota, limit range values as needed.

## Delete

By clicking on the delete option in the quota table the user will be able to perform delete operation, a confirmation modal will open which will prompt the user to delete or cancel operation.
Binary file added content/images/quotaCreationLimitRange.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/quotaCreationMetadata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/images/quotaCreationResourceQuota.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions theme_override/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ nav:
- how-to-guides/hibernation-workflow.md
- CRUD:
- how-to-guides/crud/tenant-crud-workflow.md
- how-to-guides/crud/quota-crud-workflow.md
- Integrations:
- how-to-guides/enabling-multi-tenancy-argocd.md
- how-to-guides/enabling-multi-tenancy-vault.md
Expand Down
Loading