Skip to content

Commit 460716f

Browse files
author
Tyler Graff
committed
yarn run format:fix
1 parent 331ec51 commit 460716f

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

docs/docs/references/container-sources.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
## Deploying and Running Nebari from a Private Container Repository
2-
Nebari deploys and runs FOSS components as containers running in Kubernetes.
3-
By default, Nebari sources each container from the container's respective public repository, typically `docker.io` or `quay.io`.
2+
3+
Nebari deploys and runs FOSS components as containers running in Kubernetes.
4+
By default, Nebari sources each container from the container's respective public repository, typically `docker.io` or `quay.io`.
45
This introduces supply-chain concerns for security-focused customers.
56

7+
One solution to these supply-chain concerns is to deploy Nebari from private locally-mirrored containers:
68

7-
One solution to these supply-chain concerns is to deploy Nebari from private locally-mirrored containers:
89
- Create a controlled private container repository (e.g. ECR or GitLab Container Repo)
910
- Mirror all containers used by Nebari into this private container repository
1011
- Use the `overrides` mechanism in `nebari-config.yaml` to specify the mirrored container sources
1112

12-
Deploying Nebari in this fashion eliminates significant supply chain surface-area, but requires identifying all containers used by Nebari.
13+
Deploying Nebari in this fashion eliminates significant supply chain surface-area, but requires identifying all containers used by Nebari.
1314

1415
The following configuration enumerates all container images used by Nebari 2024-9-1 and demonstrates how to source them from a private repo denoted by the string `[LOCAL_REPO]`.
1516
The commented-out elements document the original public sources from which the container images are to be mirrored.
1617

1718
### Nebari 2024-9-1 Containers
19+
1820
```
1921
default_images:
2022
#jupyterhub: quay.io/nebari/nebari-jupyterhub:2024.5.1

docs/docs/references/enhanced-security.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
## Nebari Security Considerations
22

3-
The security of *AWS Nebari* deployments can be enhanced through the following deployment configuration options in `nebari-config.yaml`:
3+
The security of _AWS Nebari_ deployments can be enhanced through the following deployment configuration options in `nebari-config.yaml`:
44

55
- **Explicit definition of container sources**
6-
This option allows for the use of locally mirrored, security-hardened, or otherwise customized container images in place of the containers used by default.
7-
See: [container-sources](container-sources-2024-09-1.md)
8-
6+
This option allows for the use of locally mirrored, security-hardened, or otherwise customized container images in place of the containers used by default.
7+
See: [container-sources](container-sources-2024-09-1.md)
98

109
- **Definition of an ssh key that can access EKS hosts**
11-
EKS hosts by default cannot be accessed via ssh. This configuration item allows ssh access into EKS hosts, which can be useful for troubleshooting or external monitoring and auditing purposes.
10+
EKS hosts by default cannot be accessed via ssh. This configuration item allows ssh access into EKS hosts, which can be useful for troubleshooting or external monitoring and auditing purposes.
11+
1212
```
1313
amazon_web_services:
1414
ec2_keypair_name: [example_keypair_name] # Name, not ARN
1515
```
16-
16+
1717
- **Installation of custom SSL certificate(s) into EKS hosts**
18-
Install private certificates used by (e.g.) in-line content inspection engines which re-encrypt traffic.
19-
```
18+
Install private certificates used by (e.g.) in-line content inspection engines which re-encrypt traffic.
19+
20+
```
2021
extra_ssl_certificates: |
2122
-----BEGIN CERTIFICATE-----
2223
MIIF...<snip>...ABCD
@@ -27,14 +28,16 @@ Install private certificates used by (e.g.) in-line content inspection engines w
2728
```
2829

2930
- **Private EKS endpoint configuration**
30-
Mirrors the corresponding AWS console option, which routes all EKS traffic within the VPC.
31+
Mirrors the corresponding AWS console option, which routes all EKS traffic within the VPC.
32+
3133
```
3234
eks_endpoint_private_access: true
3335
eks_endpoint_public_access: false
3436
```
3537

3638
- **Deploy into existing subnets**
37-
Instructs Nebari to be deployed into existing subnets, rather than creating its own new subnets.
39+
Instructs Nebari to be deployed into existing subnets, rather than creating its own new subnets.
40+
3841
```
3942
existing_subnet_ids:
4043
- subnet-0123456789abcdef
@@ -48,8 +51,9 @@ ingress:
4851
service.beta.kubernetes.io/aws-load-balancer-subnets: "subnet-0123456789abcdef,subnet-abcdef0123456789"
4952
```
5053

51-
- **Use existing SSL certificate**
52-
Instructs Nebari to use the SSL certificate specified by `[k8s-custom-secret-name]`
54+
- **Use existing SSL certificate**
55+
Instructs Nebari to use the SSL certificate specified by `[k8s-custom-secret-name]`
56+
5357
```
5458
certificate:
5559
type: existing

0 commit comments

Comments
 (0)