Skip to content

Commit 6cc799a

Browse files
addetzbenradstone
andauthored
docs: add custom endpoint AWS Secret PEM-8844 (#8694)
* docs: add custom endpoint AWS Secret PEM-8844 * docs: adjust indentation * Apply suggestions from code review Co-authored-by: Ben Radstone <[email protected]> * ci: auto-formatting prettier issues * docs: fix broken component * docs: redo longform --------- Co-authored-by: Ben Radstone <[email protected]>
1 parent 1161879 commit 6cc799a

File tree

1 file changed

+47
-1
lines changed

1 file changed

+47
-1
lines changed

docs/docs-content/clusters/public-cloud/aws/add-aws-accounts.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,13 +379,59 @@ Use the steps below to add an AWS Secret Cloud account using SCAP secure complia
379379
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
380380
| **Agency Name** | Enter the SCAP agency name. |
381381
| **Account Name** | Enter the SCAP account name or number. |
382-
| **CAP/SCAP Role Name** | Enter the role name provided by the SCAP administrator. This role determines the AWS permissions granted to the account. Note that AWS Top Secret Cloud Access Portal (CAP) credentials are not supported at this time. |
382+
| **CAP/SCAP Role Name** | Enter the role name provided by the SCAP administrator. This role determines the AWS permissions granted to the account. |
383383
| **Role Prefix (Optional)** | Choose a prefix to standardize role names. If no prefix is provided, a default prefix of `PROJECT_` is used. For example, if the initial role name is `DevOpsRole`, the full role name would be `PROJECT_DevOpsRole`. |
384384
| **Permission Boundary (Optional)** | If you want to apply a permission boundary and limit the maximum permissions a role or user can have, provide the IAM policy ARN (for example, `arn:aws:iam::123456789012:policy/MyPermissionBoundaryPolicy`). Refer to the AWS [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) page for additional information on permission boundaries. |
385385
| **Certificate Authority** | Paste the root, intermediate, or chain of trust certificate in PEM-encoded format. Contact your organization's security team or AWS Secret Cloud administrator to obtain this certificate. |
386386
| **User Certificate** | Paste your user-issued digital certificate in PEM-encoded format. |
387387
| **User Key** | Provide the private cryptographic key associated with the user certificate in PEM-encoded format. |
388388

389+
Palette provides default values for CAP/SCAP endpoints. Users can change these configurations on their
390+
[self-hosted Palette](../../../enterprise-version/enterprise-version.md) or
391+
[Palette VerteX](../../../vertex/vertex.md) installations.
392+
393+
<details>
394+
395+
<summary> Click here to learn how to provide custom CAP/SCAP endpoints. </summary>
396+
397+
1. Open a terminal window on a host that can connect to the Palette or Palette VerteX management cluster.
398+
Additionally, ensure that [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) is installed on
399+
this host.
400+
401+
2. Download the [Kubeconfig](../../cluster-management/kubeconfig.md) file of the cluster..
402+
403+
3. Open a terminal window and set the environment variable `KUBECONFIG` to point to the file you downloaded.
404+
405+
```shell
406+
export KUBECONFIG=<path-to-downloaded-kubeconfig-file>
407+
```
408+
409+
4. If you are using AWS Secret cloud accounts, use the following command to set a custom endpoint. Replace the
410+
`<customized-endpoint-url>` placeholder with your own value.
411+
412+
```shell
413+
kubectl --namespace hubble-system set env deployment/cloud CUSTOM_ISO_URL="<customized-endpoint-url>"
414+
```
415+
416+
If you are using AWS Top Secret cloud accounts, use the following command to set a custom endpoint. Replace the
417+
`<customized-endpoint-url>` placeholder with your own value.
418+
419+
```shell
420+
kubectl --namespace hubble-system set env deployment/cloud CUSTOM_ISOB_URL="<customized-endpoint-url>"
421+
```
422+
423+
5. Verify that the change has been applied with the following command.
424+
425+
```shell
426+
kubectl --namespace hubble-system get deploy cloud --output jsonpath='{.spec.template.spec.containers[*].env}'
427+
```
428+
429+
```hideClipboard title="Example output"
430+
[{"name":"CUSTOM_ISO_URL","value":"<customized-endpoint-url>"}]
431+
```
432+
433+
</details>
434+
389435
6. Click the **Validate** button to validate the credentials.
390436

391437
7. Once the credentials are validated, verified by a green check mark, the **Add IAM Policies** toggle is displayed.

0 commit comments

Comments
 (0)