Skip to content

Commit e184ca6

Browse files
committed
Auth and logging docs nits (#1931)
(cherry picked from commit 0f1b6b1)
1 parent 54039fd commit e184ca6

File tree

2 files changed

+2
-12
lines changed

2 files changed

+2
-12
lines changed

docs/clusters/aws/auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Cortex client uses the default credential provider chain to get credentials. Cre
1010

1111
### API Management
1212

13-
Cortex client relies an AWS IAM to authenticate requests (e.g. `cortex deploy`, `cortex get`) to a cluster on AWS. The client will include a get-caller-identity request that has been signed with the credentials from the default credential provider chain along with original request. The operator executes the presigned request to verify that credentials are valid and belong to the same account as the IAM entity of the cluster.
13+
Cortex client relies on AWS IAM to authenticate requests (e.g. `cortex deploy`, `cortex get`) to a cluster on AWS. The client will include a get-caller-identity request that has been signed with the credentials from the default credential provider chain along with original request. The operator executes the presigned request to verify that credentials are valid and belong to the same account as the IAM entity of the cluster.
1414

1515
AWS credentials required to authenticate cortex client requests to the operator don't require any permissions. However, managing the cluster using `cortex cluster *` commands do require permissions.
1616

@@ -56,7 +56,7 @@ When spinning up a cortex cluster, you can provide additional policies to author
5656

5757
If you already have a cluster running and would like to add additional permissions, you can update the policy that is created automatically during `cortex cluster up`. In [IAM console](https://console.aws.amazon.com/iam/home?policies#/policies) search for `cortex-<cluster_name>-<region>` to find the policy that has been attached to your cluster. Adding more permissions to this policy will automatically give more access to all of your Cortex APIs.
5858

59-
*** NOTE: The policy created during `cortex cluster up` will automatically be deleted during `cortex cluster down`. It is recommended to create your own policies that can be specified in `iam_policy_arns` field in cluster configuration. The precreated policy should only be updated for development and testing purposes. ***
59+
_NOTE: The policy created during `cortex cluster up` will automatically be deleted during `cortex cluster down`. It is recommended to create your own policies that can be specified in `iam_policy_arns` field in cluster configuration. The precreated policy should only be updated for development and testing purposes._
6060

6161
`cortex cluster up` will create a default policy which is the minimum set of IAM permissions to run your APIs and various processes on the cluster such as the operator and fluent-bit. Fields from your AWS account and cluster configuration will be used to populate the policy below.
6262

docs/workloads/observability/logging.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,6 @@ labels.apiKind="RealtimeAPI"
7777
labels.apiName="<INSERT API NAME>"
7878
```
7979

80-
**BatchAPI:**
81-
82-
```text
83-
resource.type="k8s_container"
84-
resource.labels.cluster_name="<INSERT CLUSTER NAME>"
85-
labels.apiKind="BatchAPI"
86-
labels.apiName="<INSERT API NAME>"
87-
labels.jobID="<INSERT JOB ID>"
88-
```
89-
9080
**TaskAPI:**
9181

9282
```text

0 commit comments

Comments
 (0)