-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ download BM images via ocr-registry.
- Loading branch information
Showing
9 changed files
with
347 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,7 +18,7 @@ Updating a `HetznerBareMetalMachineTemplate` is not possible. Instead, a new tem | |
|
|
||
| ## cloud-init and installimage | ||
|
|
||
| Both in installimage and cloud-init the ports used for SSH can be changed, e.g. with the following code snippet: | ||
| Both in [installimage](https://docs.hetzner.com/robot/dedicated-server/operating-systems/installimage/) and cloud-init the ports used for SSH can be changed, e.g. with the following code snippet: | ||
|
|
||
| ``` | ||
| sed -i -e '/^\(#\|\)Port/s/^.*$/Port 2223/' /etc/ssh/sshd_config | ||
|
|
@@ -39,7 +39,7 @@ Via MatchLabels you can specify a certain label (key and value) that identifies | |
| | -------------------------------------------------------------- | ------------------- | ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | template.spec.providerID | string | | no | Provider ID set by controller | | ||
| | template.spec.installImage | object | | yes | Configuration used in autosetup | | ||
| | template.spec.installImage.image | object | | yes | Defines image for bm machine. Must specify either name and url, or a (local) path | | ||
| | template.spec.installImage.image | object | | yes | Defines image for bm machine. See below for details. | | ||
| | template.spec.installImage.image.url | string | | no | Remote URL of image. Can be tar, tar.gz, tar.bz, tar.bz2, tar.xz, tgz, tbz, txz | | ||
| | template.spec.installImage.image.name | string | | no | Name of the image | | ||
| | template.spec.installImage.image.path | string | | no | Local path of a pre-installed image | | ||
|
|
@@ -75,3 +75,68 @@ Via MatchLabels you can specify a certain label (key and value) that identifies | |
| | template.spec.sshSpec.secretRef.key.privateKey | string | | yes | PrivateKey is the key in the secret's data where the SSH key's private key is stored | | ||
| | template.spec.sshSpec.portAfterInstallImage | int | 22 | no | PortAfterInstallImage specifies the port that can be used to reach the server via SSH after install image completed successfully | | ||
| | template.spec.sshSpec.portAfterCloudInit | int | 22 (install image port) | no | PortAfterCloudInit specifies the port that can be used to reach the server via SSH after cloud init completed successfully | | ||
|
|
||
| ### installImage.image | ||
|
|
||
| You must specify either name and url, or a local path. | ||
|
|
||
| Example of an image provided by Hetzner via NFS: | ||
|
|
||
| ``` | ||
| image: | ||
| path: /root/.oldroot/nfs//images/Ubuntu-2204-jammy-amd64-base.tar.gz | ||
| ``` | ||
|
|
||
| Example of an image provided by you via https. The script installimage of Hetzner parses the name to detect the version. It is | ||
| recommended to follow their naming pattern. | ||
|
|
||
| ``` | ||
| image: | ||
| name: Ubuntu-2204-jammy-amd64-custom | ||
| url: https://user:[email protected]/images/Ubuntu-2204-jammy-amd64-custom.tar.gz | ||
| ``` | ||
|
|
||
| Example of pulling an image from an oci-registry: | ||
|
|
||
| ``` | ||
| image: | ||
| name: Ubuntu-2204-jammy-amd64-custom | ||
| url: oci://ghcr.io/myorg/images/Ubuntu-2204-jammy-amd64-custom:1.0.0-beta.2 | ||
| ``` | ||
|
|
||
| If you need credentials to pull the image, then provide the environment variable `OCI_REGISTRY_AUTH_TOKEN` to the controller. | ||
|
|
||
| You can provide the variable via a secret of the deployment `caph-controller-manager`: | ||
|
|
||
| ``` | ||
| apiVersion: apps/v1 | ||
| kind: Deployment | ||
| metadata: | ||
| # ... | ||
| spec: | ||
| # ... | ||
| template: | ||
| spec: | ||
| containers: | ||
| - command: | ||
| - /manager | ||
| image: ghcr.io/syself/caph:vXXX | ||
| env: | ||
| - name: OCI_REGISTRY_AUTH_TOKEN | ||
| valueFrom: | ||
| secretKeyRef: | ||
| name: my-oci-registry-secret # The name of the secret | ||
| key: OCI_REGISTRY_AUTH_TOKEN # The key in the secret to use | ||
| # ... other container specs | ||
| ``` | ||
|
|
||
| You can push an image to a oci-registry with a tool like [oras](https://oras.land): | ||
|
|
||
| ``` | ||
| oras push ghcr.io/myorg/images/Ubuntu-2204-jammy-amd64-custom:1.0.0-beta.2 \ | ||
| --artifact-type application/vnd.myorg.machine-image.v1 Ubuntu-2204-jammy-amd64-custom.tar.gz | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| #!/bin/bash | ||
|
|
||
| # Copyright 2023 The Kubernetes Authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # This scripts gets copied from the controller into the rescue system | ||
| # of the bare-metal machine. | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| image="${1:-}" | ||
| outfile="${2:-}" | ||
|
|
||
| function usage { | ||
| echo "$0 image outfile." | ||
| echo " Download a machine image from a container registry" | ||
| echo " image: for example ghcr.io/foo/bar/my-machine-image:v9" | ||
| echo " outfile: Created file. Usualy with file extensions '.tgz'" | ||
| echo " If the oci registry needs a token, then the script uses OCI_REGISTRY_AUTH_TOKEN (if set)" | ||
| echo " Example of OCI_REGISTRY_AUTH_TOKEN: github:ghp_SN51...." | ||
| echo | ||
| } | ||
| if [ -z "$outfile" ]; then | ||
| usage | ||
| exit 1 | ||
| fi | ||
| OCI_REGISTRY_AUTH_TOKEN="${OCI_REGISTRY_AUTH_TOKEN:-}" # github:$GITHUB_TOKEN | ||
|
|
||
| # Extract registry | ||
| registry="${image%%/*}" | ||
|
|
||
| # Extract scope and tag | ||
| remainder="${image#*/}" | ||
| scope="${remainder%:*}" | ||
| tag="${remainder##*:}" | ||
|
|
||
| if [[ -z "$registry" || -z "$scope" || -z "$tag" ]]; then | ||
| echo "failed to parse registry, scope and tag from image" | ||
| echo "image=$image" | ||
| echo "registry=$registry" | ||
| echo "scope=$scope" | ||
| echo "tag=$tag" | ||
| exit 1 | ||
| fi | ||
|
|
||
| function download_with_token { | ||
| echo "download with token (OCI_REGISTRY_AUTH_TOKEN set)" | ||
| if [[ "$OCI_REGISTRY_AUTH_TOKEN" != *:* ]]; then | ||
| echo "OCI_REGISTRY_AUTH_TOKEN needs to contain a ':' (user:token)" | ||
| exit 1 | ||
| fi | ||
|
|
||
| token=$(curl -fsSL -u "$OCI_REGISTRY_AUTH_TOKEN" "https://${registry}/token?scope=repository:$scope:pull" | jq -r '.token') | ||
| if [ -z "$token" ]; then | ||
| echo "Failed to get token for container registry" | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "Login to $registry was successful" | ||
|
|
||
| digest=$(curl -sSL -H "Authorization: Bearer $token" -H "Accept: application/vnd.oci.image.manifest.v1+json" \ | ||
| "https://${registry}/v2/${scope}/manifests/${tag}" | jq -r '.layers[0].digest') | ||
|
|
||
| if [ -z "$digest" ]; then | ||
| echo "Failed to get digest from container registry" | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "Start download of $image" | ||
| curl -fsSL -H "Authorization: Bearer $token" \ | ||
| "https://${registry}/v2/${scope}/blobs/$digest" >"$outfile" | ||
| } | ||
|
|
||
| function download_without_token { | ||
| echo "download without token (OCI_REGISTRY_AUTH_TOKEN empty)" | ||
| digest=$(curl -sSL -H "Accept: application/vnd.oci.image.manifest.v1+json" \ | ||
| "https://${registry}/v2/${scope}/manifests/${tag}" | jq -r '.layers[0].digest') | ||
|
|
||
| if [ -z "$digest" ]; then | ||
| echo "Failed to get digest from container registry" | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "Start download of $image" | ||
| curl -fsSL "https://${registry}/v2/${scope}/blobs/$digest" >"$outfile" | ||
| } | ||
|
|
||
| if [ -z "$OCI_REGISTRY_AUTH_TOKEN" ]; then | ||
| download_without_token | ||
| else | ||
| download_with_token | ||
| fi |
Oops, something went wrong.