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

BigAnimal - CSP tagging #5863

Merged
merged 8 commits into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from 6 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
4 changes: 4 additions & 0 deletions product_docs/docs/biganimal/release/using_cluster/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ navigation:
- managing_replicas
- 02_connecting_your_cluster
- 03_modifying_your_cluster
- managing_cloud_account
- 04_backup_and_restore
- 05_monitoring_and_logging
- fault_injection_testing
Expand All @@ -15,6 +16,9 @@ navigation:
- 06_analyze_with_superset
- 06_demonstration_oracle_compatibility
- terraform_provider
- tagging
- pgd_cli_ba
- pgd_defaults_ba
---

Account owners and contributors can connect, edit, scale, monitor, back up, and restore clusters through the BigAnimal portal.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
---
title: "Tagging AWS resources"
deepToC: true
redirects:
- /purl/cloudservice/csp_tagging
---

Tags are key-value pairs you can apply to cloud provider resources created on your own cloud account, also known as [Your Cloud Account](/edb-postgres-ai/cloud-service/managed/). Resource tagging allows you to have fine-grained access control and granular cost data at the bucket level. When you add a tag, the following resources are labeled:
gvasquezvargas marked this conversation as resolved.
Show resolved Hide resolved

- EC2 instances
- S3 buckets
- Load balancers
- Volumes

You can create and manage tags on a per-project basis in the EDB Postgres® AI Console. The Console then applies the tag to the resources of all regions configured in your account.
gvasquezvargas marked this conversation as resolved.
Show resolved Hide resolved

## Create Tags

To create a tag:

1. Log in to the Console.

1. Go to the project's page.

1. In the project's list, select your **Project**.

1. On your project's home page left navigation, select **Cloud Providers**.

1. On the cloud provider's page, select **Your Cloud Account**.

1. On your cloud account tab, under **AWS**, select **Manage Tags**.

1. Select **Add a Key Value pair**.

1. Provide **Key** and **Value** and select **Save**.

1. A **Confirm changes to AWS tags** message pops up.

1. Select **Confirm** to add the tag.

1. This **Key:Value** pair is added at your project level. It is populated on the EC2 instances, S3 buckets, load balancers and volumes managed in that project, for all regions and clusters.

This new tag appears in the list under **AWS** on Cloud Service Providers.

This tag is also propagated on your AWS resources. For instance, you can view this tag in the **Tags** tab of your EC2 instance resources on the AWS console.

### Considerations
gvasquezvargas marked this conversation as resolved.
Show resolved Hide resolved

Consider following while adding a **Key:Value** pair:

- A number of case-sensitive keywords are reserved by AWS and EDB Cloud Service, and therefore cannot be entered as **Key**s.

<details><summary>Reserved keywords</summary>

Reserved tag key prefixes:

`aws:`, `AWS:`, `user:`, `k8s.io/`, `eks:`, `kubernetes.io/`, `elbv2.k8s.aws/`, `service.k8s.aws/`, `ebs.csi.aws.com/`

Reserved tag keys:

`Resource_type`, `Project`, `Environment`, `Topology`, `BAID`, `ManagedBy`, `biganimal-cluster`, `biganimal-project`, `CSIVolumeName`, `Name`.

</details>

<br/>

- Review the [tagging limitations of AWS](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions).

- In AWS, a resource can have a maximum number of 50 tags. The EDB Cloud Service and AWS Management Console apply some tags by default, so we recommend not adding more than 20 of your own tags. Take into account that the number of tags per resource is defined by the tags created in the EDB Console, in your cloud service provider's dashboard, with terraform, and other synced systems.

## Update Tags

To update a tag:

1. Log in to the Console.

1. Go to the project's page.

1. In the project's list, select your **Project**.

1. On your project's home page left navigation, select **Cloud Providers**.

1. On the cloud provider's page, select **Your Cloud Account**.

1. On your cloud account tab, under **AWS**, select **Manage Tags**.

1. Update the **Value** field of any of the existing tags.

1. Select **Save**.

1. A **Confirm changes to AWS tags** message pops up.

1. Select **Confirm** to update the tag.

1. This **Key:Value** pair is updated at your project level. It is populated on the EC2 instances, S3 buckets, load balancers and volumes managed in that project, for all regions and clusters.


## Delete tags

1. Log in to the Console.

1. Go to the project's page.

1. In the project's list, select your **Project**.

1. On your project's home page left navigation, select **Cloud Providers**.

1. On the cloud provider's page, select **Your Cloud Account**.

1. On your cloud account tab, under **AWS**, select **Manage Tags**.

1. Select the minus symbol (**&mdash;**) next to the Key value pair to delete the tag.

1. Select **Save**.

1. A **Confirm changes to AWS tags** message pops up.

1. Select **Confirm** to delete the tag and update the tags list.

This tag is also deleted on the AWS Console. You can confirm the tag is deleted by selecting the **Tags** tab of your EC2 instance resources on AWS console.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "Managing resources on Your Cloud Account"
---

Some configuration options are available to projects and clusters created on Your Cloud Account.

- [Tagging resources in a Project](csp_tagging)