-
-
Notifications
You must be signed in to change notification settings - Fork 61
Add crossplane-cli feature #208
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
joebowbeer
wants to merge
3
commits into
devcontainers-extra:main
Choose a base branch
from
joebowbeer:crossplane-cli
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,39 @@ | ||
| { | ||
| "id": "crossplane-cli", | ||
| "version": "1.0.0", | ||
| "name": "crossplane-cli", | ||
| "documentationURL": "http://github.com/devcontainers-extra/features/tree/main/src/crossplane-cli", | ||
| "description": "Installs crossplane CLI, which provides utilities to make using Crossplane easier.", | ||
| "options": { | ||
| "version": { | ||
| "type": "string", | ||
| "proposals": [ | ||
| "current" | ||
| ], | ||
| "default": "current", | ||
| "description": "Select version of crossplane" | ||
| }, | ||
| "channel": { | ||
| "type": "string", | ||
| "proposals": [ | ||
| "stable", | ||
| "preview", | ||
| "master" | ||
| ], | ||
| "default": "stable", | ||
| "description": "Select channel of crossplane releases" | ||
| } | ||
| }, | ||
| "customizations": { | ||
| "vscode": { | ||
| "settings": { | ||
| "github.copilot.chat.codeGeneration.instructions": [ | ||
| { | ||
| "text": "This dev container includes crossplane pre-installed and available on the `PATH`." | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "installsAfter": [] | ||
| } |
This file contains hidden or 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,28 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -e | ||
|
|
||
| source ./library_scripts.sh | ||
|
|
||
| # nanolayer is a cli utility which keeps container layers as small as possible | ||
| # source code: https://github.com/devcontainers-extra/nanolayer | ||
| # `ensure_nanolayer` is a bash function that will find any existing nanolayer installations, | ||
| # and if missing - will download a temporary copy that automatically get deleted at the end | ||
| # of the script | ||
| ensure_nanolayer nanolayer_location "v0.5.6" | ||
|
|
||
| $nanolayer_location \ | ||
| install \ | ||
| devcontainer-feature \ | ||
| "ghcr.io/devcontainers-extra/features/apt-get-packages:1.0.6" \ | ||
| --option packages='curl,ca-certificates' | ||
|
|
||
| export XP_VERSION="${VERSION:-"current"}" | ||
| export XP_CHANNEL="${CHANNEL:-"stable"}" | ||
|
|
||
| curl -sSL "https://raw.githubusercontent.com/crossplane/crossplane/main/install.sh" | sh | ||
|
|
||
| chmod +x crossplane | ||
| mv crossplane /usr/local/bin | ||
|
|
||
| echo 'Done!' | ||
This file contains hidden or 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,173 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| clean_download() { | ||
| # The purpose of this function is to download a file with minimal impact on container layer size | ||
| # this means if no valid downloader is found (curl or wget) then we install a downloader (currently wget) in a | ||
| # temporary manner, and making sure to | ||
| # 1. uninstall the downloader at the return of the function | ||
| # 2. revert back any changes to the package installer database/cache (for example apt-get lists) | ||
| # The above steps will minimize the leftovers being created while installing the downloader | ||
| # Supported distros: | ||
| # debian/ubuntu/alpine | ||
|
|
||
| url=$1 | ||
| output_location=$2 | ||
| tempdir=$(mktemp -d) | ||
| downloader_installed="" | ||
|
|
||
| function _apt_get_install() { | ||
| tempdir=$1 | ||
|
|
||
| # copy current state of apt list - in order to revert back later (minimize contianer layer size) | ||
| cp -p -R /var/lib/apt/lists $tempdir | ||
| apt-get update -y | ||
| apt-get -y install --no-install-recommends wget ca-certificates | ||
| } | ||
|
|
||
| function _apt_get_cleanup() { | ||
| tempdir=$1 | ||
|
|
||
| echo "removing wget" | ||
| apt-get -y purge wget --auto-remove | ||
|
|
||
| echo "revert back apt lists" | ||
| rm -rf /var/lib/apt/lists/* | ||
| rm -r /var/lib/apt/lists && mv $tempdir/lists /var/lib/apt/lists | ||
| } | ||
|
|
||
| function _apk_install() { | ||
| tempdir=$1 | ||
| # copy current state of apk cache - in order to revert back later (minimize contianer layer size) | ||
| cp -p -R /var/cache/apk $tempdir | ||
|
|
||
| apk add --no-cache wget | ||
| } | ||
|
|
||
| function _apk_cleanup() { | ||
| tempdir=$1 | ||
|
|
||
| echo "removing wget" | ||
| apk del wget | ||
| } | ||
| # try to use either wget or curl if one of them already installer | ||
| if type curl >/dev/null 2>&1; then | ||
| downloader=curl | ||
| elif type wget >/dev/null 2>&1; then | ||
| downloader=wget | ||
| else | ||
| downloader="" | ||
| fi | ||
|
|
||
| # in case none of them is installed, install wget temporarly | ||
| if [ -z $downloader ]; then | ||
| if [ -x "/usr/bin/apt-get" ]; then | ||
| _apt_get_install $tempdir | ||
| elif [ -x "/sbin/apk" ]; then | ||
| _apk_install $tempdir | ||
| else | ||
| echo "distro not supported" | ||
| exit 1 | ||
| fi | ||
| downloader="wget" | ||
| downloader_installed="true" | ||
| fi | ||
|
|
||
| if [ $downloader = "wget" ]; then | ||
| wget -q $url -O $output_location | ||
| else | ||
| curl -sfL $url -o $output_location | ||
| fi | ||
|
|
||
| # NOTE: the cleanup procedure was not implemented using `trap X RETURN` only because | ||
| # alpine lack bash, and RETURN is not a valid signal under sh shell | ||
| if ! [ -z $downloader_installed ]; then | ||
| if [ -x "/usr/bin/apt-get" ]; then | ||
| _apt_get_cleanup $tempdir | ||
| elif [ -x "/sbin/apk" ]; then | ||
| _apk_cleanup $tempdir | ||
| else | ||
| echo "distro not supported" | ||
| exit 1 | ||
| fi | ||
| fi | ||
|
|
||
| } | ||
|
|
||
| ensure_nanolayer() { | ||
| # Ensure existance of the nanolayer cli program | ||
| local variable_name=$1 | ||
|
|
||
| local required_version=$2 | ||
| # normalize version | ||
| if ! [[ $required_version == v* ]]; then | ||
| required_version=v$required_version | ||
| fi | ||
|
|
||
| local nanolayer_location="" | ||
|
|
||
| # If possible - try to use an already installed nanolayer | ||
| if [[ -z "${NANOLAYER_FORCE_CLI_INSTALLATION}" ]]; then | ||
| if [[ -z "${NANOLAYER_CLI_LOCATION}" ]]; then | ||
| if type nanolayer >/dev/null 2>&1; then | ||
| echo "Found a pre-existing nanolayer in PATH" | ||
| nanolayer_location=nanolayer | ||
| fi | ||
| elif [ -f "${NANOLAYER_CLI_LOCATION}" ] && [ -x "${NANOLAYER_CLI_LOCATION}" ]; then | ||
| nanolayer_location=${NANOLAYER_CLI_LOCATION} | ||
| echo "Found a pre-existing nanolayer which were given in env variable: $nanolayer_location" | ||
| fi | ||
|
|
||
| # make sure its of the required version | ||
| if ! [[ -z "${nanolayer_location}" ]]; then | ||
| local current_version | ||
| current_version=$($nanolayer_location --version) | ||
| if ! [[ $current_version == v* ]]; then | ||
| current_version=v$current_version | ||
| fi | ||
|
|
||
| if ! [ $current_version == $required_version ]; then | ||
| echo "skipping usage of pre-existing nanolayer. (required version $required_version does not match existing version $current_version)" | ||
| nanolayer_location="" | ||
| fi | ||
| fi | ||
|
|
||
| fi | ||
|
|
||
| # If not previuse installation found, download it temporarly and delete at the end of the script | ||
| if [[ -z "${nanolayer_location}" ]]; then | ||
|
|
||
| if [ "$(uname -sm)" == "Linux x86_64" ] || [ "$(uname -sm)" == "Linux aarch64" ]; then | ||
| tmp_dir=$(mktemp -d -t nanolayer-XXXXXXXXXX) | ||
|
|
||
| clean_up() { | ||
| ARG=$? | ||
| rm -rf $tmp_dir | ||
| exit $ARG | ||
| } | ||
| trap clean_up EXIT | ||
|
|
||
| if [ -x "/sbin/apk" ]; then | ||
| clib_type=musl | ||
| else | ||
| clib_type=gnu | ||
| fi | ||
|
|
||
| tar_filename=nanolayer-"$(uname -m)"-unknown-linux-$clib_type.tgz | ||
|
|
||
| # clean download will minimize leftover in case a downloaderlike wget or curl need to be installed | ||
| clean_download https://github.com/devcontainers-extra/nanolayer/releases/download/$required_version/$tar_filename $tmp_dir/$tar_filename | ||
|
|
||
| tar xfzv $tmp_dir/$tar_filename -C "$tmp_dir" | ||
| chmod a+x $tmp_dir/nanolayer | ||
| nanolayer_location=$tmp_dir/nanolayer | ||
|
|
||
| else | ||
| echo "No binaries compiled for non-x86-linux architectures yet: $(uname -m)" | ||
| exit 1 | ||
| fi | ||
| fi | ||
|
|
||
| # Expose outside the resolved location | ||
| declare -g ${variable_name}=$nanolayer_location | ||
|
|
||
| } |
This file contains hidden or 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,41 @@ | ||
| { | ||
| "test_debian": { | ||
| "image": "mcr.microsoft.com/devcontainers/base:debian", | ||
| "features": { | ||
| "crossplane-cli": {} | ||
| } | ||
| }, | ||
| "test_ubuntu": { | ||
| "image": "mcr.microsoft.com/devcontainers/base:ubuntu", | ||
| "features": { | ||
| "crossplane-cli": {} | ||
| } | ||
| }, | ||
| "test_stable_current": { | ||
| "image": "mcr.microsoft.com/devcontainers/base:debian", | ||
| "features": { | ||
| "crossplane-cli": { | ||
| "channel": "stable", | ||
| "version": "current" | ||
| } | ||
| } | ||
| }, | ||
| "test_preview_current": { | ||
| "image": "mcr.microsoft.com/devcontainers/base:debian", | ||
| "features": { | ||
| "crossplane-cli": { | ||
| "channel": "preview", | ||
| "version": "current" | ||
| } | ||
| } | ||
| }, | ||
| "test_master_current": { | ||
| "image": "mcr.microsoft.com/devcontainers/base:debian", | ||
| "features": { | ||
| "crossplane-cli": { | ||
| "channel": "master", | ||
| "version": "current" | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains hidden or 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,9 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -e | ||
|
|
||
| source dev-container-features-test-lib | ||
|
|
||
| check "crossplane is installed" crossplane -h | ||
|
|
||
| reportResults |
This file contains hidden or 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,9 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -e | ||
|
|
||
| source dev-container-features-test-lib | ||
|
|
||
| check "crossplane version is v2" sh -c "crossplane version 2>&1 | grep 'Client Version: v2'" | ||
|
|
||
| reportResults |
This file contains hidden or 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,9 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -e | ||
|
|
||
| source dev-container-features-test-lib | ||
|
|
||
| check "crossplane version is v2" sh -c "crossplane version 2>&1 | grep 'Client Version: v2'" | ||
|
|
||
| reportResults |
This file contains hidden or 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,9 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -e | ||
|
|
||
| source dev-container-features-test-lib | ||
|
|
||
| check "crossplane version is v2" sh -c "crossplane version 2>&1 | grep 'Client Version: v2'" | ||
|
|
||
| reportResults |
This file contains hidden or 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,9 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -e | ||
|
|
||
| source dev-container-features-test-lib | ||
|
|
||
| check "crossplane is installed" crossplane -h | ||
|
|
||
| reportResults |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you know if this script changes frequently? I think I would prefer to save it alongside the rest of the feature's files (maybe as
bootstrap.shorupstream-install.sh), and then execute it from there.I'm not a fan of downloading a script from somewhere and piping it to shell
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI: That's what I did today for Claude Code feature here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It changes a couple times a year, usually in a minor way.
https://github.com/crossplane/crossplane/commits/main/install.sh