Créer un cluster GKE et déployer une charge de travail à l'aide de Terraform

Créer un cluster GKE et déployer une charge de travail à l'aide de Terraform

Autopilot

---

Dans ce guide de démarrage rapide, vous allez apprendre à créer un cluster Google Kubernetes Engine (GKE) Autopilot et à déployer une charge de travail à l'aide de Terraform.

L'Infrastructure as Code (IaC) est une pratique qui consiste à gérer et à provisionner des ressources d'infrastructure logicielle à l'aide de code. Terraform est un outil IaC Open Source populaire compatible avec un large éventail de services cloud, y compris GKE. En tant qu'administrateur de plate-forme GKE, vous pouvez utiliser Terraform pour standardiser la configuration de vos clusters Kubernetes et optimiser vos workflows DevOps. Pour en savoir plus, consultez la section Compatibilité de Terraform avec GKE.

Objectifs

• Créer un réseau cloud privé virtuel (VPC) IPv6
• Créer un cluster GKE Autopilot
• Déployer une charge de travail sur votre cluster
• Exposer la charge de travail à l'aide d'un service

Avant de commencer

Procédez comme suit pour activer l'API Kubernetes Engine :

1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the GKE API.

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the GKE API.

   Enable the API

8. Make sure that you have the following role or roles on the project: roles/container.admin, roles/compute.networkAdmin, roles/iam.serviceAccountUser

   Check for the roles

   1. In the Google Cloud console, go to the IAM page.

      Go to IAM
   2. Select the project.

   3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

   4. For all rows that specify or include you, check the Role colunn to see whether the list of roles includes the required roles.

   Grant the roles

   1. In the Google Cloud console, go to the IAM page.

      Accéder à IAM
   2. Sélectionnez le projet.
   3. Cliquez sur Accorder l'accès.

   4. Dans le champ Nouveaux comptes principaux, saisissez votre identifiant utilisateur. Il s'agit généralement de l'adresse e-mail d'un compte Google.

   5. Dans la liste Sélectionner un rôle, sélectionnez un rôle.
   6. Pour attribuer des rôles supplémentaires, cliquez sur Ajouter un autre rôle et ajoutez chaque rôle supplémentaire.
   7. Cliquez sur Enregistrer.

   Avant de lire plus en détail ce document, assurez-vous de bien connaître les concepts Terraform dans les ressources suivantes :

   • Premiers pas avec Terraform (vidéo)
   • Commandes Terraform

Préparer l'environnement

Dans ce tutoriel, vous utilisez Cloud Shell pour gérer les ressources hébergées sur Google Cloud. Cloud Shell est préinstallé avec les logiciels dont vous avez besoin dans ce tutoriel, y compris Terraform, kubectl et Google Cloud CLI.

1. Lancez une session Cloud Shell depuis la console Google Cloud en cliquant sur l'icône d'activation Cloud Shell Activer Cloud Shell . Une session s'ouvre dans le volet inférieur de la console Google Cloud.

   Les identifiants de service associés à cette machine virtuelle sont automatiques. Vous n'avez donc pas besoin de configurer ni de télécharger une clé de compte de service.

   Remarque : Si vous n'utilisez pas Cloud Shell, veillez à configurer l'environnement GOOGLE_PROJECT ou une variable équivalente, et à configurer l'authentification.

2. Avant d'exécuter des commandes, définissez votre projet par défaut dans gcloud CLI à l'aide de la commande suivante :

   gcloud config set project PROJECT_ID
   

   Remplacez PROJECT_ID par votre ID de projet.

3. Clonez le dépôt GitHub.

   git clone https://github.com/terraform-google-modules/terraform-docs-samples.git --single-branch
   

4. Accédez au répertoire de travail :

   cd terraform-docs-samples/gke/quickstart/autopilot
   

Examiner les fichiers Terraform

Le fournisseur Google Cloud est un plug-in qui vous permet de gérer et de provisionner des ressources Google Cloud à l'aide de Terraform, l'outil IaC (Infrastructure as Code) de HashiCorp. Il sert de passerelle entre les configurations Terraform et les API Google Cloud, ce qui vous permet de définir des ressources d'infrastructure, telles que des machines virtuelles et des réseaux, de manière déclarative.

1. Examinez le fichier cluster.tf :

   cat cluster.tf
   

   Le résultat ressemble à ce qui suit :

   resource "google_compute_network" "default" {
     name = "example-network"
   
     auto_create_subnetworks  = false
     enable_ula_internal_ipv6 = true
   }
   
   resource "google_compute_subnetwork" "default" {
     name = "example-subnetwork"
   
     ip_cidr_range = "10.0.0.0/16"
     region        = "us-central1"
   
     stack_type       = "IPV4_IPV6"
     ipv6_access_type = "INTERNAL" # Change to "EXTERNAL" if creating an external loadbalancer
   
     network = google_compute_network.default.id
     secondary_ip_range {
       range_name    = "services-range"
       ip_cidr_range = "192.168.0.0/24"
     }
   
     secondary_ip_range {
       range_name    = "pod-ranges"
       ip_cidr_range = "192.168.1.0/24"
     }
   }
   
   resource "google_container_cluster" "default" {
     name = "example-autopilot-cluster"
   
     location                 = "us-central1"
     enable_autopilot         = true
     enable_l4_ilb_subsetting = true
   
     network    = google_compute_network.default.id
     subnetwork = google_compute_subnetwork.default.id
   
     ip_allocation_policy {
       stack_type                    = "IPV4_IPV6"
       services_secondary_range_name = google_compute_subnetwork.default.secondary_ip_range[0].range_name
       cluster_secondary_range_name  = google_compute_subnetwork.default.secondary_ip_range[1].range_name
     }
   
     # Set `deletion_protection` to `true` will ensure that one cannot
     # accidentally delete this instance by use of Terraform.
     deletion_protection = false
   }

   Ce fichier décrit les ressources suivantes :

   • Un réseau VPC avec l'IPv6 interne activé. Pour exposer votre application sur Internet, remplacez ipv6_access_type par EXTERNAL. Si vous apportez cette modification, vous devez également supprimer l'annotation networking.gke.io/load-balancer-type du fichier app.tf à l'étape suivante.
   • Un sous-réseau à double pile.
   • Un cluster Autopilot à double pile situé dans us-central1.

2. Examinez le fichier app.tf :

   cat app.tf
   

   Le résultat ressemble à ce qui suit :

   data "google_client_config" "default" {}
   
   provider "kubernetes" {
     host                   = "https://${google_container_cluster.default.endpoint}"
     token                  = data.google_client_config.default.access_token
     cluster_ca_certificate = base64decode(google_container_cluster.default.master_auth[0].cluster_ca_certificate)
   
     ignore_annotations = [
       "^autopilot\\.gke\\.io\\/.*",
       "^cloud\\.google\\.com\\/.*"
     ]
   }
   
   resource "kubernetes_deployment_v1" "default" {
     metadata {
       name = "example-hello-app-deployment"
     }
   
     spec {
       selector {
         match_labels = {
           app = "hello-app"
         }
       }
   
       template {
         metadata {
           labels = {
             app = "hello-app"
           }
         }
   
         spec {
           container {
             image = "us-docker.pkg.dev/google-samples/containers/gke/hello-app:2.0"
             name  = "hello-app-container"
   
             port {
               container_port = 8080
               name           = "hello-app-svc"
             }
   
             security_context {
               allow_privilege_escalation = false
               privileged                 = false
               read_only_root_filesystem  = false
   
               capabilities {
                 add  = []
                 drop = ["NET_RAW"]
               }
             }
   
             liveness_probe {
               http_get {
                 path = "/"
                 port = "hello-app-svc"
   
                 http_header {
                   name  = "X-Custom-Header"
                   value = "Awesome"
                 }
               }
   
               initial_delay_seconds = 3
               period_seconds        = 3
             }
           }
   
           security_context {
             run_as_non_root = true
   
             seccomp_profile {
               type = "RuntimeDefault"
             }
           }
   
           # Toleration is currently required to prevent perpetual diff:
           # https://github.com/hashicorp/terraform-provider-kubernetes/pull/2380
           toleration {
             effect   = "NoSchedule"
             key      = "kubernetes.io/arch"
             operator = "Equal"
             value    = "amd64"
           }
         }
       }
     }
   }
   
   resource "kubernetes_service_v1" "default" {
     metadata {
       name = "example-hello-app-loadbalancer"
       annotations = {
         "networking.gke.io/load-balancer-type" = "Internal" # Remove to create an external loadbalancer
       }
     }
   
     spec {
       selector = {
         app = kubernetes_deployment_v1.default.spec[0].selector[0].match_labels.app
       }
   
       ip_family_policy = "RequireDualStack"
   
       port {
         port        = 80
         target_port = kubernetes_deployment_v1.default.spec[0].template[0].spec[0].container[0].port[0].name
       }
   
       type = "LoadBalancer"
     }
   
     depends_on = [time_sleep.wait_service_cleanup]
   }
   
   # Provide time for Service cleanup
   resource "time_sleep" "wait_service_cleanup" {
     depends_on = [google_container_cluster.default]
   
     destroy_duration = "180s"
   }

   Ce fichier décrit les ressources suivantes :

   • Un déploiement avec un exemple d'image de conteneur.
   • Un service de type LoadBalancer. Le service expose le déploiement sur le port 80. Pour exposer votre application sur Internet, configurez un équilibreur de charge externe en supprimant l'annotation networking.gke.io/load-balancer-type.

Créer un cluster et déployer une application

1. Dans Cloud Shell, exécutez la commande suivante pour vérifier que Terraform est disponible :

   terraform
   

   La sortie devrait ressembler à ce qui suit :

   Usage: terraform [global options] <subcommand> [args]
   
   The available commands for execution are listed below.
   The primary workflow commands are given first, followed by
   less common or more advanced commands.
   
   Main commands:
     init          Prepare your working directory for other commands
     validate      Check whether the configuration is valid
     plan          Show changes required by the current configuration
     apply         Create or update infrastructure
     destroy       Destroy previously-created infrastructure
   

2. Initialisez Terraform :

   terraform init
   

3. Planifiez la configuration Terraform :

   terraform plan
   

4. Appliquez la configuration Terraform :

   terraform apply
   

   Lorsque vous y êtes invité, saisissez yes pour confirmer les actions. Cette commande peut prendre plusieurs minutes. Le résultat ressemble à ce qui suit :

   Apply complete! Resources: 6 added, 0 changed, 0 destroyed.
   

Vérifier que le cluster fonctionne

Procédez comme suit pour vérifier que votre cluster fonctionne correctement :

1. Accédez à la page Charges de travail dans la console Google Cloud :

   Accéder à la page Charges de travail

2. Cliquez sur la charge de travail example-hello-app-deployment. La page des détails du pod s'affiche. Cette page affiche des informations sur le pod, telles que les annotations, les conteneurs s'exécutant sur le pod, les services exposant le pod, mais aussi les métriques telles que l'utilisation du processeur, de la mémoire et du disque.

3. Accédez à la page Services et entrées de la console Google Cloud :

   Accéder à la page Services et entrées

4. Cliquez sur le Service LoadBalancer example-hello-app-loadbalancer. La page "Informations sur le service" s'affiche. Cette page affiche des informations sur le service, telles que les pods associés et les ports utilisés par les services.

5. Dans la section Points de terminaison externes, cliquez sur lien IPv4 ou lien IPv6 pour afficher votre service dans le navigateur. Le résultat ressemble à ce qui suit :

   Hello, world!
   Version: 2.0.0
   Hostname: example-hello-app-deployment-5df979c4fb-kdwgr
   

Opération réussie : vous avez créé un cluster et déployé une charge de travail sur GKE à l'aide de Terraform.

Effectuer un nettoyage

Pour éviter que les ressources utilisées sur cette page soient facturées sur votre compte Google Cloud, procédez comme suit :

Pour éviter que les ressources utilisées sur cette page ne soient facturées sur votre compte Google Cloud, procédez comme suit :

Dans Cloud Shell, exécutez la commande suivante pour supprimer les ressources Terraform :

terraform destroy --auto-approve

Si un message d'erreur semblable à The network resource 'projects/PROJECT_ID/global/networks/example-network' is already being used by 'projects/PROJECT_ID/global/firewalls/example-network-yqjlfql57iydmsuzd4ot6n5v' apparaît, procédez comme suit :

1. Supprimez les règles de pare-feu :

   gcloud compute firewall-rules list --filter="NETWORK:example-network" --format="table[no-heading](name)" | xargs gcloud --quiet compute firewall-rules delete
   

2. Exécutez à nouveau la commande Terraform :

   terraform destroy --auto-approve
   

Étapes suivantes

• Explorez les ressources google_container_cluster et google_container_node_pool dans la documentation du fournisseur Google Cloud. Ces pages répertorient les arguments et les attributs des clusters ainsi que la configuration des pools de nœuds GKE compatibles avec Terraform.
• Consultez des exemples de configuration rigoureuses dans le dépôt GitHub du module Terraform GKE.