-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Allow the Kubernetes agent to be registered with a pre-install hook (#…
…1057) * Add register.sh preinstall hook * Add migration command for agent pre-installation * Fix downloader tools on MacOS * Add migration command tests * Test fixes * Add unimplemented client config provider to allow help initialization * Add better exception logging * Set environment variable to allow test to run * Update test * PR Feedback * PR feedback * Add environment variable for specifying alternate stores for the agent
- Loading branch information
1 parent
ea2aeed
commit de91283
Showing
14 changed files
with
726 additions
and
10 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,328 @@ | ||
| #!/bin/bash | ||
| set -eu | ||
|
|
||
| if [[ "$ACCEPT_EULA" != "Y" ]]; then | ||
| echo "ERROR: You must accept the EULA at https://octopus.com/company/legal by passing an environment variable 'ACCEPT_EULA=Y'" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # In the scenario where a customer is using a custom certificate (which is mounted via a config map), we need to rehash the certificates | ||
| # We just do this all the time because there is no downside | ||
| echo "Rehashing SSL/TLS certificates" | ||
| openssl rehash /etc/ssl/certs | ||
|
|
||
| # Tentacle Docker images only support once instance per container. Running multiple instances can be achieved by running multiple containers. | ||
| instanceName=Tentacle | ||
| internalListeningPort=10933 | ||
|
|
||
| #If TentacleHome environment variable exists, use that | ||
| configurationDirectory=/etc/octopus | ||
| if [[ -n "$TentacleHome" ]]; then | ||
| configurationDirectory="$TentacleHome" | ||
| fi | ||
|
|
||
| #If TentacleApplications environment variable exists, use that | ||
| applicationsDirectory=/home/Octopus/Applications | ||
| if [[ -n "$TentacleApplications" ]]; then | ||
| applicationsDirectory="$TentacleApplications" | ||
| fi | ||
|
|
||
| mkdir -p $configurationDirectory | ||
| mkdir -p $applicationsDirectory | ||
|
|
||
| if [ ! -f /usr/bin/tentacle ]; then | ||
| ln -s /opt/octopus/tentacle/Tentacle /usr/bin/tentacle | ||
| fi | ||
|
|
||
| function getPublicHostName() { | ||
| if [[ "$PublicHostNameConfiguration" == "PublicIp" ]]; then | ||
| curl https://api.ipify.org/ | ||
| elif [[ "$PublicHostNameConfiguration" == "FQDN" ]]; then | ||
| hostname --fqdn | ||
| elif [[ "$PublicHostNameConfiguration" == "ComputerName" ]]; then | ||
| hostname | ||
| else | ||
| echo $CustomPublicHostName | ||
| fi | ||
| } | ||
|
|
||
| function validateVariables() { | ||
| validateCommonVariables | ||
|
|
||
| if [[ "$DeploymentTargetEnabled" != "true" && "$WorkerEnabled" != "true" ]]; then | ||
| echo "Please specify whether to install as a worker or a deployment target with the 'WorkerEnabled' or 'DeploymentTargetEnabled' environment variables" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| if [[ "$DeploymentTargetEnabled" == "true" && "$WorkerEnabled" == "true" ]]; then | ||
| echo "The installation cannot be as both a worker and a deployment target, please choose one" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| if [[ "$DeploymentTargetEnabled" == "true" ]]; then | ||
| validateDeploymentTargetVariables | ||
| fi | ||
|
|
||
| if [[ "$WorkerEnabled" == "true" ]]; then | ||
| validateWorkerVariables | ||
| fi | ||
| } | ||
|
|
||
| function validateCommonVariables() { | ||
| if [[ -z "$ServerApiKey" && -z "$BearerToken" ]]; then | ||
| if [[ -z "$ServerPassword" || -z "$ServerUsername" ]]; then | ||
| echo "Please specify either an API key, a Bearer Token or a username/password with the 'ServerApiKey' or 'ServerUsername'/'ServerPassword' environment variables" >&2 | ||
| exit 1 | ||
| fi | ||
| fi | ||
|
|
||
| if [[ -z "$ServerUrl" ]]; then | ||
| echo "Please specify an Octopus Server with the 'ServerUrl' environment variable" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo " - server endpoint '$ServerUrl'" | ||
| echo " - api key '##########'" | ||
| echo " - host '$PublicHostNameConfiguration'" | ||
|
|
||
| if [[ -n "$ServerCommsAddress" || -n "$ServerCommsAddresses" || -n "$ServerPort" ]]; then | ||
| echo " - communication mode 'Kubernetes' (Polling)" | ||
|
|
||
| if [[ -n "$ServerCommsAddress" ]]; then | ||
| echo " - server comms address $ServerCommsAddress" | ||
| fi | ||
| if [[ -n "$ServerCommsAddresses" ]]; then | ||
| echo " - HA server comms addresses $ServerCommsAddresses" | ||
| fi | ||
| if [[ -n "$ServerPort" ]]; then | ||
| echo " - server port $ServerPort" | ||
| fi | ||
| if [[ -n "$ServerSubscriptionId" ]]; then | ||
| echo " - server subscription id '$ServerSubscriptionId'" | ||
| fi | ||
| else | ||
| echo " - communication mode 'Kubernetes' (Listening)" | ||
| echo " - registered port $ListeningPort" | ||
| fi | ||
|
|
||
| if [[ -n "$AgentName" ]]; then | ||
| echo " - name '$AgentName'" | ||
| fi | ||
|
|
||
| if [[ -n "$Space" ]]; then | ||
| echo " - space '$Space'" | ||
| fi | ||
|
|
||
| if [[ -n "$TentacleCertificateBase64" ]]; then | ||
| echo " - tentacle certificate '${TentacleCertificateBase64:0:3}...${TentacleCertificateBase64: -3}'" | ||
| fi | ||
| } | ||
|
|
||
| function validateDeploymentTargetVariables() { | ||
| if [[ -z "$TargetEnvironment" ]]; then | ||
| echo "Please specify one or more environment names/ids/slugs (comma delimited) with the 'TargetEnvironment' environment variable" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| if [[ -z "$TargetRole" ]]; then | ||
| echo "Please specify one or more role names (comma delimited) with the 'TargetRole' environment variable" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo " - environment '$TargetEnvironment'" | ||
| echo " - role '$TargetRole'" | ||
|
|
||
| if [[ -n "$TargetTenant" ]]; then | ||
| echo " - tenant '$TargetTenant'" | ||
| fi | ||
| if [[ -n "$TargetTenantTag" ]]; then | ||
| echo " - tenant tag '$TargetTenantTag'" | ||
| fi | ||
| if [[ -n "$TargetTenantedDeploymentParticipation" ]]; then | ||
| echo " - tenanted deployment participation '$TargetTenantedDeploymentParticipation'" | ||
| fi | ||
|
|
||
| if [[ -n "$DefaultNamespace" ]]; then | ||
| echo " - default namespace '$DefaultNamespace'" | ||
| fi | ||
| } | ||
|
|
||
| function validateWorkerVariables() { | ||
| if [[ -z "$WorkerPools" ]]; then | ||
| echo "Please specify one or more worker pool names/ids/slugs (comma delimited) with the 'WorkerPools' environment variable" >&2 | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo " - worker pools '$WorkerPools'" | ||
| } | ||
|
|
||
| function configureTentacle() { | ||
| tentacle create-instance --instance "$instanceName" --config "$configurationDirectory/tentacle.config" --home "$configurationDirectory" | ||
|
|
||
| echo "Setting directory paths ..." | ||
| tentacle configure --instance "$instanceName" --app "$applicationsDirectory" | ||
|
|
||
| echo "Configuring communication type ..." | ||
| if [[ -n "$ServerCommsAddress" || -n "$ServerCommsAddresses" || -n "$ServerPort" ]]; then | ||
| tentacle configure --instance "$instanceName" --noListen "True" | ||
| else | ||
| tentacle configure --instance "$instanceName" --port $internalListeningPort --noListen "False" | ||
| fi | ||
|
|
||
| if [[ -n "$TentacleCertificateBase64" ]]; then | ||
| echo "Importing custom certificate ..." | ||
| tentacle import-certificate --instance "$instanceName" --from-base64="$TentacleCertificateBase64" | ||
| else | ||
| echo "Creating certificate ..." | ||
| tentacle new-certificate --instance "$instanceName" --if-blank | ||
| fi | ||
| } | ||
|
|
||
| function setupVariablesForRegistrationCheck() { | ||
| local namespace=$(cat /var/run/secrets/kubernetes.io/serviceaccount/namespace) | ||
| local config_map_name="tentacle-config" | ||
| SERVICE_URL="https://$KUBERNETES_SERVICE_HOST:$KUBERNETES_SERVICE_PORT/api/v1/namespaces/$namespace/configmaps/$config_map_name" | ||
| SERVICE_ACCOUNT_TOKEN_PATH="/var/run/secrets/kubernetes.io/serviceaccount/token" | ||
| } | ||
|
|
||
| function getStatusOfRegistration() { | ||
| echo "Checking registration status..." | ||
|
|
||
| IS_REGISTERED=$(curl -s --request GET \ | ||
| --url "$SERVICE_URL" \ | ||
| --header "Authorization: Bearer $(cat $SERVICE_ACCOUNT_TOKEN_PATH)" \ | ||
| --header 'Accept: application/json' \ | ||
| --cacert /var/run/secrets/kubernetes.io/serviceaccount/ca.crt | | ||
| grep -o '"Tentacle.Services.IsRegistered": "[^"]*"' | | ||
| cut -d'"' -f4) | ||
| } | ||
|
|
||
| function registerTentacle() { | ||
| echo "Registering with server ..." | ||
|
|
||
| local ARGS=() | ||
|
|
||
| if [[ "$DeploymentTargetEnabled" == "true" ]]; then | ||
| ARGS+=('register-k8s-target') | ||
|
|
||
| if [[ -n "$TargetEnvironment" ]]; then | ||
| IFS=',' read -ra ENVIRONMENTS <<<"$TargetEnvironment" | ||
| for i in "${ENVIRONMENTS[@]}"; do | ||
| ARGS+=('--environment' "$i") | ||
| done | ||
| fi | ||
|
|
||
| if [[ -n "$TargetRole" ]]; then | ||
| IFS=',' read -ra ROLES <<<"$TargetRole" | ||
| for i in "${ROLES[@]}"; do | ||
| ARGS+=('--role' "$i") | ||
| done | ||
| fi | ||
|
|
||
| if [[ -n "$TargetTenant" ]]; then | ||
| IFS=',' read -ra TENANTS <<<"$TargetTenant" | ||
| for i in "${TENANTS[@]}"; do | ||
| ARGS+=('--tenant' "$i") | ||
| done | ||
| fi | ||
|
|
||
| if [[ -n "$TargetTenantTag" ]]; then | ||
| IFS=',' read -ra TENANTTAGS <<<"$TargetTenantTag" | ||
| for i in "${TENANTTAGS[@]}"; do | ||
| ARGS+=('--tenanttag' "$i") | ||
| done | ||
| fi | ||
|
|
||
| if [[ -n "$TargetTenantedDeploymentParticipation" ]]; then | ||
| ARGS+=('--tenanted-deployment-participation' "$TargetTenantedDeploymentParticipation") | ||
| fi | ||
|
|
||
| if [[ -n "$DefaultNamespace" ]]; then | ||
| ARGS+=('--default-namespace' "$DefaultNamespace") | ||
| fi | ||
| elif [[ "$WorkerEnabled" == "true" ]]; then | ||
| ARGS+=('register-k8s-worker') | ||
|
|
||
| if [[ -n "$WorkerPools" ]]; then | ||
| IFS=',' read -ra WORKERPOOLS <<<"$WorkerPools" | ||
| for i in "${WORKERPOOLS[@]}"; do | ||
| ARGS+=('--workerpool' "$i") | ||
| done | ||
| fi | ||
| fi | ||
|
|
||
| ARGS+=( | ||
| '--instance' "$instanceName" | ||
| '--server' "$ServerUrl" | ||
| '--space' "$Space" | ||
| '--policy' "$MachinePolicy") | ||
|
|
||
| if [[ -n "$AgentName" ]]; then | ||
| ARGS+=('--name' "$AgentName") | ||
| fi | ||
|
|
||
| if [[ -n "$ServerCommsAddress" || -n "$ServerCommsAddresses" || -n "$ServerPort" ]]; then | ||
| ARGS+=('--comms-style' 'TentacleActive') | ||
|
|
||
| # If ServerCommsAddress (singular) is not set, use the first value in ServerCommsAddresses (plural) | ||
| if [[ -n "$ServerCommsAddress" ]]; then | ||
| ARGS+=('--server-comms-address' "$ServerCommsAddress") | ||
| elif [[ -n "$ServerCommsAddresses" ]]; then | ||
| IFS=',' read -ra SERVER_ADDRESSES <<<"$ServerCommsAddresses" | ||
| ARGS+=('--server-comms-address' "${SERVER_ADDRESSES[0]}") | ||
| fi | ||
|
|
||
| if [[ -n "$ServerPort" ]]; then | ||
| ARGS+=('--server-comms-port' $ServerPort) | ||
| fi | ||
|
|
||
| if [[ -n "$ServerSubscriptionId" ]]; then | ||
| ARGS+=('--server-subscription-id' $ServerSubscriptionId) | ||
| fi | ||
| else | ||
| ARGS+=( | ||
| '--comms-style' 'TentaclePassive' | ||
| '--publicHostName' $(getPublicHostName)) | ||
|
|
||
| if [[ -n "$ListeningPort" && "$ListeningPort" != "$internalListeningPort" ]]; then | ||
| ARGS+=('--tentacle-comms-port' $ListeningPort) | ||
| fi | ||
| fi | ||
|
|
||
| if [[ -n "$ServerApiKey" ]]; then | ||
| echo "Registering Tentacle with API key" | ||
| ARGS+=('--apiKey' $ServerApiKey) | ||
| elif [[ -n "$BearerToken" ]]; then | ||
| echo "Registering Tentacle with Bearer Token" | ||
| ARGS+=('--bearerToken' "$BearerToken") | ||
| else | ||
| echo "Registering Tentacle with username/password" | ||
| ARGS+=( | ||
| '--username' "$ServerUsername" | ||
| '--password' "$ServerPassword") | ||
| fi | ||
|
|
||
| tentacle "${ARGS[@]}" | ||
| } | ||
|
|
||
| setupVariablesForRegistrationCheck | ||
| getStatusOfRegistration | ||
|
|
||
| if [ "$IS_REGISTERED" == "true" ]; then | ||
| echo "Tentacle is already configured and registered with server." | ||
| else | ||
| echo "===============================================" | ||
| echo "Configuring Octopus Deploy Kubernetes Tentacle" | ||
| echo "===============================================" | ||
|
|
||
| validateVariables | ||
|
|
||
| configureTentacle | ||
| registerTentacle | ||
| echo "Configuration successful" | ||
| fi | ||
|
|
||
| echo "===============================================" | ||
| echo "Finished Configuring Octopus Deploy Kubernetes Tentacle" | ||
| echo "===============================================" | ||
| exit 0 |
Oops, something went wrong.