Skip to content

Commit 07f85a8

Browse files
authored
[version-4-3] docs: backport/version-4-3/pr-7694 (#7706)
1 parent 1c03294 commit 07f85a8

File tree

2 files changed

+52
-32
lines changed

2 files changed

+52
-32
lines changed

docs/docs-content/registries-and-packs/registries/oci-registry/add-oci-helm.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,31 @@ You can add an OCI type Helm registry to Palette and use the Helm Charts in your
1111

1212
## Prerequisites
1313

14-
- You must have a private OCI type Helm registry that supports basic authentication. Public OCI registries are not
15-
supported.
14+
- Tenant admin access to Palette.
1615

17-
- Credentials to access the OCI registry. If you are using an AWS ECR registry, you must have the AWS credentials to an
18-
IAM user or add a trust relationship to an IAM role so that Palette can access the registry.
16+
- Credentials to access the OCI registry. If you are using an Amazon Elastic Container Registry (ECR), you must have the
17+
AWS credentials to an IAM user or add a trust relationship to an IAM role so that Palette can access the registry.
1918

2019
- If the OCI registry is using a self-signed certificate, or a certificate that is not signed by a trusted certificate
2120
authority (CA), you will need the certificate to add the registry to Palette.
2221

23-
- Tenant admin access to Palette.
22+
- If you are using an Amazon ECR and your [Palette](../../../enterprise-version/enterprise-version.md) or
23+
[Palette VerteX](../../../vertex/vertex.md) instance is installed in an airgapped environment or an environment with
24+
limited internet access, you must whitelist the S3 endpoint that corresponds to the region of your Amazon ECR. This is
25+
because image layers are stored in S3, not the registry. The S3 endpoint uses the following format. Replace `<region>`
26+
with the region your ECR is hosted in.
27+
28+
```shell
29+
prod-<region>-starport-layer-bucket.s3.<region>.amazonaws.com
30+
```
31+
32+
```shell hideClipboard title="Example S3 endpoint"
33+
prod-us-east-1-starport-layer-bucket.s3.us-east-1.amazonaws.com
34+
```
2435

25-
- If you are using an AWS ECR registry, ensure you have the following Identity Access Management (IAM) permissions
26-
attached to the IAM user or IAM role that Palette will use to access the registry. You can reduce the `Resource` scope
27-
from `*` to the specific Amazon Resource Name (ARN) of the AWS ECR registry you are using.
36+
- If you are using an Amazon ECR, ensure you have the following Identity Access Management (IAM) permissions attached to
37+
the IAM user or IAM role that Palette will use to access the registry. You can reduce the `Resource` scope from `*` to
38+
the specific Amazon Resource Name (ARN) of the ECR you are using.
2839

2940
```json
3041
{
@@ -100,7 +111,7 @@ registry you are adding.
100111

101112
</TabItem>
102113

103-
<TabItem value="aws" label="AWS ECR">
114+
<TabItem value="aws" label="Amazon ECR">
104115

105116
1. Log in to the [Palette](https://console.spectrocloud.com) as a Tenant administrator.
106117

@@ -118,12 +129,11 @@ registry you are adding.
118129

119130
8. Provide the registry URL in the **Endpoint** field. Exclude the `https://` prefix.
120131

121-
9. If you are using a private ECR registry, toggle the **Enable Authentication** option to expose the authentication
122-
fields.
132+
9. If you are using a private ECR, toggle the **Enable Authentication** option to expose the authentication fields.
123133

124134
10. Select the **AWS Authentication Method**. Choose **Credentials** if you want to provide the static AWS credentials
125-
for an IAM user. Choose **STS** if you want to Palette to assume an IAM role that has access to the ECR registry
126-
through the Security Token Service (STS). Refer to the table below to learn more about each credential type.
135+
for an IAM user. Choose **STS** if you want Palette to assume an IAM role that has access to the ECR through the
136+
Security Token Service (STS). Refer to the table below to learn more about each credential type.
127137

128138
#### Credentials
129139

@@ -143,9 +153,9 @@ registry you are adding.
143153
:::warning
144154

145155
If you selected **STS** as the authentication method, you must add a trust relationship to the IAM role you are using to
146-
access the ECR registry. Refer to the instructions exposed in the side-drawer to the right of the input field to review
147-
the IAM trust relationship changes you must add to your IAM role. Failure to add the trust relationship will result in
148-
an error when you attempt to validate the registry.
156+
access the ECR. Refer to the instructions exposed in the side-drawer to the right of the input field to review the IAM
157+
trust relationship changes you must add to your IAM role. Failure to add the trust relationship will result in an error
158+
when you attempt to validate the registry.
149159

150160
:::
151161

docs/docs-content/registries-and-packs/registries/oci-registry/add-oci-packs.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,31 @@ For guidance on how to add a custom pack to an OCI pack registry, check out the
2020

2121
## Prerequisites
2222

23-
- You must have a private OCI type Pack registry that supports basic authentication. Public OCI registries are not
24-
supported.
23+
- Tenant admin access to Palette.
2524

26-
- Credentials to access the OCI registry. If you are using an AWS ECR registry, you must have the AWS credentials to an
27-
IAM user or add a trust relationship to an IAM role so that Palette can access the registry.
25+
- Credentials to access the OCI registry. If you are using an Amazon Elastic Container Registry (ECR), you must have the
26+
AWS credentials to an IAM user or add a trust relationship to an IAM role so that Palette can access the registry.
2827

2928
- If the OCI registry is using a self-signed certificate, or a certificate that is not signed by a trusted certificate
3029
authority (CA), you will need the certificate to add the registry to Palette.
3130

32-
- Tenant admin access to Palette.
31+
- If you are using an Amazon ECR and your [Palette](../../../enterprise-version/enterprise-version.md) or
32+
[Palette VerteX](../../../vertex/vertex.md) instance is installed in an airgapped environment or an environment with
33+
limited internet access, you must whitelist the S3 endpoint that corresponds to the region of your Amazon ECR. This is
34+
because image layers are stored in S3, not the registry. The S3 endpoint uses the following format. Replace `<region>`
35+
with the region your ECR is hosted in.
36+
37+
```shell
38+
prod-<region>-starport-layer-bucket.s3.<region>.amazonaws.com
39+
```
40+
41+
```shell hideClipboard title="Example S3 endpoint"
42+
prod-us-east-1-starport-layer-bucket.s3.us-east-1.amazonaws.com
43+
```
3344

34-
- If you are using an AWS ECR registry, ensure you have the following Identity Access Management (IAM) permissions
35-
attached to the IAM user or IAM role that Palette will use to access the registry. You can reduce the `Resource` scope
36-
from `*` to the specific Amazon Resource Name (ARN) of the AWS ECR registry you are using.
45+
- If you are using an Amazon ECR, ensure you have the following Identity Access Management (IAM) permissions attached to
46+
the IAM user or IAM role that Palette will use to access the registry. You can reduce the `Resource` scope from `*` to
47+
the specific Amazon Resource Name (ARN) of the ECR you are using.
3748

3849
```json
3950
{
@@ -113,7 +124,7 @@ registry you are adding.
113124

114125
</TabItem>
115126

116-
<TabItem value="aws" label="AWS ECR">
127+
<TabItem value="aws" label="Amazon ECR">
117128

118129
1. Log in to the [Palette](https://console.spectrocloud.com) as a Tenant administrator.
119130

@@ -135,12 +146,11 @@ registry you are adding.
135146
if the OCI registry URL is `https://registry.example.com` and the OCI Packs are stored in the `custom` repository,
136147
the base content path is `custom`.
137148

138-
10. If you are using a private ECR registry, toggle the **Enable Authentication** option to expose the authentication
139-
fields.
149+
10. If you are using a private ECR, toggle the **Enable Authentication** option to expose the authentication fields.
140150

141151
11. Select the **AWS Authentication Method**. Choose **Credentials** if you want to provide the static AWS credentials
142-
for an IAM user. Choose **STS** if you want to Palette to assume an IAM role that has access to the ECR registry
143-
through the Security Token Service (STS). Refer to the table below to learn more about each credential type.
152+
for an IAM user. Choose **STS** if you want Palette to assume an IAM role that has access to the ECR through the
153+
Security Token Service (STS). Refer to the table below to learn more about each credential type.
144154

145155
#### Credentials
146156

@@ -160,9 +170,9 @@ registry you are adding.
160170
:::warning
161171

162172
If you selected **STS** as the authentication method, you must add a trust relationship to the IAM role you are using to
163-
access the ECR registry. Refer to the instructions exposed in the side-drawer to the right of the input field to review
164-
the IAM trust relationship changes you must add to your IAM role. Failure to add the trust relationship will result in
165-
an error when you attempt to validate the registry.
173+
access the ECR. Refer to the instructions exposed in the side-drawer to the right of the input field to review the IAM
174+
trust relationship changes you must add to your IAM role. Failure to add the trust relationship will result in an error
175+
when you attempt to validate the registry.
166176

167177
:::
168178

0 commit comments

Comments
 (0)