Skip to content

Commit

Permalink
abu-add-kms-usage-explicit (#813)
Browse files Browse the repository at this point in the history
* clarify few items in doc
  • Loading branch information
abuabraham-ttd authored Jan 31, 2025
1 parent 0db893c commit 91e885f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions docs/guides/operator-guide-aws-marketplace.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,10 @@ The following table lists all resources that are created during the [deployment]

| Name | Type | Description |
|:------|:------|:-------------|
| `KMSKey` | `AWS::KMS::Key` | The key for secret encryption (for configuration strings). |
| `KMSKey` | `AWS::KMS::Key` | Custom KMS key used for encrypting the secrets in AWS Secrets Manager. |
| `SSMKeyAlias` | `AWS::KMS::Alias` | An alias that provides an easy way to access the [KMS](https://aws.amazon.com/kms/) key. |
| `TokenSecret` | `AWS::SecretsManager::Secret` | An encrypted configuration that includes the operator key. |
| `WorkerRole` | `AWS::IAM::Role` | The IAM role that your UID2 Operators run as. Roles provide access to configuration keys. |
| `TokenSecret` | `AWS::SecretsManager::Secret` | A Secrets Manager secret to store the operator key. |
| `WorkerRole` | `AWS::IAM::Role` | The IAM role that your UID2 Operators run as. The role provides access to AWS Secrets Manager to retrieve operator keys. |
| `WorkerInstanceProfile` | `AWS::IAM::InstanceProfile` | The instance profile with Worker Role to attach to Operator EC2 instances. |
| `SecurityGroup` | `AWS::EC2::SecurityGroup` | A security group policy that provides rules for operator instances. See also [Security Group Policy](#security-group-policy).|
| `LaunchTemplate` | `AWS::EC2::LaunchTemplate` | A launch template with all configurations in place. You can spawn new UID2 Operator instances from it. |
Expand All @@ -136,7 +136,7 @@ To avoid passing certificates associated with your domain into the enclave, inbo
| ----------- | --------- | -------- | ------ |
| 80 | Inbound | HTTP | Serves all UID2 APIs, including the healthcheck endpoint `/ops/healthcheck`.<br/>When everything is up and running, the endpoint returns HTTP 200 with a response body of `OK`. For details, see [Checking UID2 Operator Status](#checking-uid2-operator-status). |
| 9080 | Inbound | HTTP | Serves Prometheus metrics (`/metrics`). |
| 443 | Outbound | HTTPS | Calls the UID2 Core Service; updates opt-out data and key store. |
| 443 | Outbound | HTTPS | Calls the UID2 Core Service, AWS S3, to download files for opt-out data and key store. |

### VPC Chart

Expand Down Expand Up @@ -216,7 +216,7 @@ To create a load balancer and a target operator auto-scaling group, complete the
2. Click **Create Load Balancer**.
3. On the Load balancer types page, in the **Application Load Balancer** section, click **Create**.
4. Enter the UID2 **Load balancer name**. Depending on whether or not you need to access UID2 APIs from public internet, choose the **Internet-facing** or **Internal** scheme.
5. Select the **VPC** for your targets and at least two subnets used in your CloudFormation stack.
5. Select the **VPC** you used while creating the CloudFormation stack, and at least two subnets.
6. Under **Security groups**, click **Create new security group** and do the following:
1. Enter `UID2SGALB` as its **Security group name**, as well as a relevant **Description**.
2. Under **Inbound rules**, click **Add rule**, then select the **HTTPS** Type and an appropriate **Source** according to your requirements.
Expand Down Expand Up @@ -332,7 +332,7 @@ These are the default settings for the following reasons:

### Changing the Log Rotation Schedule

To change the log rotation schedule, update the `etc/logrotate.d/operator-logrotate.conf` file.
To change the log rotation schedule, update the `etc/logrotate.d/operator-logrotate.conf` file.

Follow the instructions in the logrotate documentation: see [logrotate(8) - Linux man](https://linux.die.net/man/8/logrotate) page.

Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/_private-operator-attest-failure.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
When a Private Operator fails to attest with the Core service, one of the following actions happens:
- HTTP 401 response. The Private Operator terminates itself immediately.
- Likely Causes: API key revoked or incorrect.
- Likely Causes: Operator key revoked or incorrect.
- Any other non-200 response code. The Private Operator continues to function for 12 hours. If the issue is not resolved in this time frame, it terminates itself.
- Likely Causes: Core service issues, network issues.

Expand Down

0 comments on commit 91e885f

Please sign in to comment.