Convertire le configurazioni di Deployment Manager con DM Convert

Questa pagina descrive il processo di utilizzo di DM Convert per convertire le configurazioni di Deployment Manager in Kubernetes Resource Model (KRM) o Terraform.

Configura l'ambiente

Configura le variabili di ambiente

Salva le seguenti variabili di ambiente, che verranno utilizzate nel resto di questa guida:

export PROJECT_ID=$(gcloud config get-value project) \
export DM_CONVERT_IMAGE="us-central1-docker.pkg.dev/\
dm-convert-host/deployment-manager/dm-convert:public-preview"

Configurare gli strumenti

Devi avere accesso ai seguenti strumenti:

• gcloud

• docker

• kubectl

• bq

• jq

Se utilizzi Cloud Shell per eseguire DM Convert, hai già accesso a questi strumenti.

Convertire le configurazioni

A livello generale, esegui la migrazione della configurazione di Deployment Manager a Terraform o KRM nel seguente modo:

1. Preparazione di un deployment Deployment Manager per la conversione.

2. Conversione della configurazione nel formato HCL (HashiCorp Configuration Language, per Terraform) o KRM (Kubernetes Resource Model).

3. Utilizzando Terraform o Config Connector per applicare la configurazione convertita.

4. Abbandono del deployment Deployment Manager esistente.

Preparare il deployment esistente

DM Convert opera su file di configurazione e modelli di Deployment Manager. Nel corso della guida, questi file verranno creati e salvati localmente come input per lo strumento DM Convert.

Puoi creare un file di configurazione autonomamente o acquisirne uno da un deployment live.

Convertire un file di configurazione

Puoi utilizzare la seguente configurazione di esempio per provare il convertitore. Sostituisci PROJECT_ID con l'ID del tuo progetto Google Cloud e salva i contenuti riportati di seguito in un file denominato deployment.yaml:

  resources:
  - name: bigquerydataset
    type: bigquery.v2.dataset
    properties:
      datasetReference:
        datasetId: bigquerydataset
        projectId: PROJECT_ID
      defaultTableExpirationMs: 36000000
      location: us-west1
  - type: bigquery.v2.table
    name: bigquerytable
    properties:
      datasetId: bigquerydataset
      labels:
        data-source: external
        schema-type: auto-junk
      tableReference:
        projectId: PROJECT_ID
        tableId: bigquerytable
    metadata:
      dependsOn:
      - bigquerydataset

• Acquisire una configurazione da un deployment attivo

  Se vuoi acquisire e convertire la configurazione di un deployment attivo, puoi recuperare la configurazione espansa e salvarla su disco eseguendo i seguenti comandi, sostituendo DEPLOYMENT_NAME con il nome del deployment.

  # Configure your project/deployment
  DEPLOYMENT_NAME=DEPLOYMENT_NAME
  PROJECT_ID=PROJECT_ID
  
  # Fetch the latest manifest for the given deployment
  gcloud deployment-manager deployments describe $DEPLOYMENT_NAME \
    --project $PROJECT_ID --format="value(deployment.manifest)"
  https://www.googleapis.com/deploymentmanager/v2/projects/$PROJECT_ID/global/deployments/bq/manifests/manifest-1618872644848
  
  # The manifest name is the last path segment from the URI
  # in the above command output
  MANIFEST_NAME="manifest-1618872644848"
  # Save the expanded manifest to deployment.yaml
  gcloud deployment-manager manifests describe $MANIFEST_NAME \
    --deployment $DEPLOYMENT_NAME --project $PROJECT_ID \
    --format="value(expandedConfig)" > deployment.yaml
  

Convertire il deployment

Per convertire le risorse in deployment.yaml nel formato HCL o KRM e salvarle come output convertiti, esegui il seguente comando nella stessa directory di deployment.yaml con le sostituzioni desiderate:

CONVERTED_RESOURCES=OUTPUT_FILE

docker run --rm -it --workdir=/convert \
--volume=$(pwd):/convert \
$DM_CONVERT_IMAGE \
--config deployment.yaml \
--output_format OUTPUT_FORMAT \
--output_file OUTPUT_FILE \
--output_tf_import_file OUTPUT_IMPORT_FILE \
--deployment_name DEPLOYMENT_NAME \
--project_id $PROJECT_ID

Effettua le seguenti sostituzioni:

• OUTPUT_FORMAT: il formato di output per la conversione. Può essere TF per Terraform o KRM per KRM.

• OUTPUT_FILE: il nome del file in cui viene salvato l'output convertito.

• (solo Terraform) OUTPUT_IMPORT_FILE: il nome del file in cui vengono salvati i comandi di importazione Terraform. Se viene specificato un flag project_id, i comandi di importazione vengono generati in base a quel flag. Se non viene specificato un flag project_id, i comandi di importazione vengono generati in base all'attributo projectId della configurazione della risorsa.

• DEPLOYMENT_NAME: il nome del deployment. Questo è pertinente se utilizzi modelli nella configurazione di Deployment Manager e utilizzi anche la variabile di ambiente deployment. Per ulteriori informazioni, visita la pagina Utilizzare una variabile di ambiente.

Visualizzare le conversioni

# Print output file
cat OUTPUT_FILE

Applica la configurazione convertita

# Configure default project
cat <<EOF > echo > main.tf
provider "google" {
  project = "$PROJECT_ID"
}
EOF

# NOTE: if Terraform state gets corrupted during testing,
# use init --reconfigure to reset backend
terraform init
echo "***************  TERRAFORM PLAN  ******************"
terraform plan
echo "**************  TERRAFORM APPLY  ******************"
terraform apply

# NOTE: if Terraform state gets corrupted during testing,
# use init --reconfigure to reset backend
terraform init

cat OUTPUT_IMPORT_FILE

# Make the import file executable
chmod +x OUTPUT_IMPORT_FILE
# Perform the import
./OUTPUT_IMPORT_FILE

terraform plan

Terraform will perform the following actions:

# google_bigquery_dataset.bigquerydataset will be updated in-place
~ resource "google_bigquery_dataset" "bigquerydataset" {
    ...
    ~ labels = {
        # the label value will be based on the deployment name and may not
        # match
        - "goog-dm" = "bq-for-import" -> null
      }
    ...
  }

# google_bigquery_table.bigquerytable will be updated in-place
~ resource "google_bigquery_table" "bigquerytable" {
    ...
    ~ labels = {
        # the label value will be based on the deployment name and may not
        # match
        - "goog-dm" = "bq-for-import" -> null
      }
    ...
  }

Plan: 0 to add, 2 to change, 0 to destroy.

# Accept changes by entering yes when prompted
terraform apply

...
# change from 10 hrs to 12 hrs
default_table_expiration_ms = 43200000
...

# Accept changes by entering yes when prompted
terraform apply
# Access the dataset properties via bq to verify the changes
bq show --format=prettyjson bigquerydataset | jq '.defaultTableExpirationMs'

gcloud container clusters get-credentials GKE_CLUSTER

# Ensure that the namespace is annotated to create resources in the correct
# project/folder/organization. https://cloud.google.com/config-connector/docs/how-to/install-upgrade-uninstall#specify
kubectl apply -n CONFIG_CONNECTOR_NAMESPACE \
  -f OUTPUT_FILE

# Wait for the resources to become healthy
kubectl wait -n CONFIG_CONNECTOR_NAMESPACE \
  --for=condition=Ready \
  --timeout=5m -f OUTPUT_FILE

Esegui la pulizia

Esegui la pulizia del set di dati e della tabella di esempio

# NOTE: if Terraform state gets corrupted during testing,
# use init --reconfigure to reset backend
echo "***************  TERRAFORM INIT  ******************"
terraform init
# Remove delete protection on BigQuery table
sed -i "/resource \"google_bigquery_table\"/a deletion_protection=\"false\"" \
OUTPUT_FILE
terraform apply
echo "***************  TERRAFORM DESTROY ****************"
terraform destroy

# If the resource was created via Config Connector:
kubectl delete -n CONFIG_CONNECTOR_NAMESPACE \
  -f OUTPUT_FILE

Abbandona il deployment di esempio di Deployment Manager

Per abbandonare un deployment live che hai convertito correttamente in KRM o Terraform, esegui:

gcloud deployment-manager deployments delete DEPLOYMENT_NAME --delete-policy ABANDON

Risorse supportate per la conversione

docker run --rm -it \
us-central1-docker.pkg.dev/dm-convert-host/deployment-manager/dm-convert:public-preview \
--output_format tf \
--list_supported_types

docker run --rm -it \
us-central1-docker.pkg.dev/dm-convert-host/deployment-manager/dm-convert:public-preview \
--output_format krm \
--list_supported_types

Passaggi successivi

Esamina le best practice e i consigli per la configurazione convertita.