Skip to content

Commit 917d80a

Browse files
Backport: Copy platform/install/advanced/air-gapped.mdx to platform_versioned_docs/version-4.2.0/install/advanced/air-gapped.mdx (#758)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent d2b60bd commit 917d80a

File tree

1 file changed

+28
-40
lines changed

1 file changed

+28
-40
lines changed

platform_versioned_docs/version-4.2.0/install/advanced/air-gapped.mdx

Lines changed: 28 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -161,24 +161,24 @@ Follow these steps to populate the registry with the specific images needed for
161161
Download the text files from the [vCluster GitHub release](https://github.com/loft-sh/vcluster/releases).
162162

163163
The `images.txt` or `vcluster-images.txt` files contain multiple Kubernetes versions and distributions. You can edit the file and remove the images for any unwanted versions and distributions.
164-
164+
165165
```bash title="Download image text file for vCluster v0.25.0+ versions"
166166
wget https://github.com/loft-sh/vcluster/releases/download/v${VCLUSTER_VERSION}/images.txt
167167
```
168168

169169
```bash title="Download image text file for vCluster < v0.25.0 versions"
170170
wget https://github.com/loft-sh/vcluster/releases/download/v${VCLUSTER_VERSION}/vClusterimages.txt
171171
```
172-
172+
173173
</Step>
174174
<Step>
175175

176-
**Optional**: Download the scripts from the [vCluster GitHub release](https://github.com/loft-sh/vcluster/releases) and make them executable.
177-
176+
**Optional**: Download the scripts from the [vCluster GitHub release](https://github.com/loft-sh/vcluster/releases) and make them executable.
177+
178178
:::note
179179
If you've already completed this as part of populating the platform images, you can skip this step.
180-
:::
181-
180+
:::
181+
182182
```bash title="Download prepare scripts"
183183
wget https://github.com/loft-sh/vcluster/releases/download/v${VCLUSTER_VERSION}/download-images.sh
184184
wget https://github.com/loft-sh/vcluster/releases/download/v${VCLUSTER_VERSION}/push-images.sh
@@ -206,7 +206,7 @@ Follow these steps to populate the registry with the specific images needed for
206206

207207
Run `push-images.sh` to upload all required images to your private registry.
208208

209-
Images are pushed to your private registry without public registry references, preserving only the repository and image name.
209+
Images are pushed to your private registry without public registry references, preserving only the repository and image name.
210210
You can configure vCluster to use your private registry for all deployments.
211211

212212
```bash title="Push images to private registry"
@@ -465,16 +465,12 @@ It is recommended to install vCluster Platform on its own host cluster.
465465
Read more about how to quickly create a [secret from your docker login](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_create/kubectl_create_secret_docker-registry/).
466466

467467
```bash title="Example of how to create a Kubernetes secret for login credentials"
468-
kubectl create -f - <<EOF
469-
apiVersion: v1
470-
kind: Secret
471-
metadata:
472-
name: registry-credentials-secret-name
473-
namespace: ${PLATFORM_NAMESPACE}
474-
type: Opaque
475-
data:
476-
# Credentials based on your private registry
477-
EOF
468+
kubectl create secret docker-registry registry-credentials-secret-name \
469+
--namespace ${PLATFORM_NAMESPACE} \
470+
--docker-server=<your-registry-server> \
471+
--docker-username=<your-username> \
472+
--docker-password=<your-password> \
473+
--docker-email=<your-email>
478474
```
479475

480476
</Step>
@@ -530,16 +526,12 @@ chart is adding additional variables to figure out how to connect to the platfor
530526
For more details, see [Create a Secret from your Docker login](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_create/kubectl_create_secret_docker-registry/).
531527

532528
```bash title=" Create a Kubernetes secret for login credentials example"
533-
kubectl create -f - <<EOF
534-
apiVersion: v1
535-
kind: Secret
536-
metadata:
537-
name: registry-credentials-secret-name
538-
namespace: ${AGENT_NAMESPACE}
539-
type: Opaque
540-
data:
541-
# Credentials based on your private registry
542-
EOF
529+
kubectl create secret docker-registry registry-credentials-secret-name \
530+
--namespace ${AGENT_NAMESPACE} \
531+
--docker-server=<your-registry-server> \
532+
--docker-username=<your-username> \
533+
--docker-password=<your-password> \
534+
--docker-email=<your-email>
543535
```
544536

545537
</Step>
@@ -651,13 +643,13 @@ sync:
651643

652644
</details>
653645

654-
### Deploy vCluster through the platform
646+
### Deploy vCluster through the platform
655647

656-
When deploying vCluster through the platform console, you'll must add your `vcluster.yaml`.
648+
When deploying vCluster through the platform console, you must add your `vcluster.yaml`.
657649

658650
#### Use an authenticated private registry
659651

660-
If you are using a private registry with authentication, you'll need to create a Kubernetes secret that stores your login credentials. Place this secret in the same namespace where the vCluster is deployed so the control plane can pull the required container images.
652+
If you are using a private registry with authentication, you must create a Kubernetes secret that stores your login credentials. Place this secret in the same namespace where the vCluster is deployed so the control plane can pull the required container images.
661653

662654
In the options for the config, there is a section called `Host namespace`, add the yaml for the secret in the `Kubernetes objects` section.
663655

@@ -719,16 +711,12 @@ In the options for the config, there is a section called `Host namespace`, add t
719711
export VCLUSTER_NAMESPACE=vcluster-my-vcluster # Replace with the name of the namespace you want to deploy your vCluster into
720712
kubectl create namespace ${VCLUSTER_NAMESPACE}
721713
722-
kubectl create -f - <<EOF
723-
apiVersion: v1
724-
kind: Secret
725-
metadata:
726-
name: registry-credentials-secret-name
727-
namespace: ${VCLUSTER_NAMESPACE}
728-
type: Opaque
729-
data:
730-
# Credentials based on your private registry
731-
EOF
714+
kubectl create secret docker-registry registry-credentials-secret-name \
715+
--namespace ${VCLUSTER_NAMESPACE} \
716+
--docker-server=<your-registry-server> \
717+
--docker-username=<your-username> \
718+
--docker-password=<your-password> \
719+
--docker-email=<your-email>
732720
```
733721

734722
</Step>

0 commit comments

Comments
 (0)