Wdrażanie w Kubernetes Engine aplikacji Spring Boot w Javie w Google Kubernetes Engine

1. Zanim zaczniesz

Kubernetes to projekt open source, który może działać w wielu różnych środowiskach, od laptopów po klastry z wieloma węzłami o wysokiej dostępności, od chmur publicznych po wdrożenia lokalne i od instancji maszyn wirtualnych po Bare Metal.

W ramach tego ćwiczenia w programie wdrożysz w Kubernetes w GKE prostą aplikację internetową Spring Boot w języku Java. Celem jest uruchomienie aplikacji internetowej jako repliki w Kubernetes. Pobierzesz kod opracowany na komputerze, zmienisz go w obraz kontenera Dockera i uruchomisz obraz w GKE.

Wykorzystasz GKE – w pełni zarządzaną usługę Kubernetes w Google Cloud – pozwoli Ci to skupić się na korzystaniu z Kubernetes zamiast na konfigurowanie bazowej infrastruktury.

Jeśli zamierzasz używać platformy Kubernetes na swoim komputerze lokalnym (np. na laptopie programistycznym), zapoznaj się z usługą Minikube, która oferuje prostą konfigurację klastra Kubernetes z jednym węzłem do celów programistycznych i testowania. Jeśli chcesz, możesz wykonać ćwiczenia z programowania za pomocą Minikube.

W ćwiczeniach w Codelabs zostanie wykorzystany przykładowy kod z przewodnika Tworzenie aplikacji za pomocą Spring Boot.

Wymagania wstępne

• Znajomość języka programowania i narzędzi Java
• znajomości standardowych edytorów tekstu systemu Linux, takich jak Vim, Emacs czy nano;

Co trzeba zrobić

• spakować prostą aplikację w Javie jako kontener Dockera,
• Utwórz klaster Kubernetes w GKE.
• wdrożyć w Kubernetes w GKE aplikację w Javie,
• Przeskaluj usługę w górę i wdróż uaktualnienie.
• Dostęp do panelu – internetowego interfejsu użytkownika Kubernetes.

Czego potrzebujesz

• Projekt Google Cloud
• przeglądarki, np. Google Chrome;

2. Konfiguracja i wymagania

Samodzielne konfigurowanie środowiska

1. Zaloguj się w konsoli Google Cloud i utwórz nowy projekt lub wykorzystaj już istniejący. Jeśli nie masz jeszcze konta Gmail ani Google Workspace, musisz je utworzyć.

• Nazwa projektu jest wyświetlaną nazwą uczestników tego projektu. To ciąg znaków, który nie jest używany przez interfejsy API Google. W każdej chwili możesz ją zaktualizować.
• Identyfikator projektu jest unikalny we wszystkich projektach Google Cloud i nie można go zmienić (po jego ustawieniu nie można go zmienić). Cloud Console automatycznie wygeneruje unikalny ciąg znaków. zwykle nieważne, co ona jest. W większości ćwiczeń w Codelabs musisz podać swój identyfikator projektu (zwykle identyfikowany jako PROJECT_ID). Jeśli nie podoba Ci się wygenerowany identyfikator, możesz wygenerować kolejny losowy. Możesz też spróbować własnych sił i sprawdzić, czy jest dostępna. Po wykonaniu tej czynności nie można jej już zmienić. Pozostanie ona przez cały czas trwania projektu.
• Jest jeszcze trzecia wartość, numer projektu, z którego korzystają niektóre interfejsy API. Więcej informacji o wszystkich 3 wartościach znajdziesz w dokumentacji.

Uwaga: identyfikator projektu jest unikalny globalnie i nie może być użyty przez nikogo innego po jego wybraniu. Jesteś jedynym użytkownikiem tego identyfikatora. Nawet po usunięciu projektu identyfikatora nie można użyć ponownie

Uwaga: jeśli używasz konta Gmail, jako domyślną lokalizację możesz pozostawić ustawienie Brak organizacji. Jeśli używasz konta Google Workspace, wybierz lokalizację odpowiednią dla Twojej organizacji.

2. Następnie musisz włączyć płatności w Cloud Console, aby korzystać z zasobów Cloud/interfejsów API. Ukończenie tego ćwiczenia z programowania nic nie kosztuje. Aby wyłączyć zasoby w celu uniknięcia naliczania opłat po zakończeniu tego samouczka, możesz usunąć utworzone zasoby lub projekt. Nowi użytkownicy Google Cloud mogą skorzystać z programu bezpłatnego okresu próbnego o wartości 300 USD.

Aktywowanie Cloud Shell

1. W konsoli Cloud kliknij Aktywuj Cloud Shell .

Jeśli uruchamiasz Cloud Shell po raz pierwszy, zobaczysz ekran pośredni z opisem tej usługi. Jeśli wyświetlił się ekran pośredni, kliknij Dalej.

Uzyskanie dostępu do Cloud Shell i połączenie się z nim powinno zająć tylko kilka chwil.

Ta maszyna wirtualna ma wszystkie potrzebne narzędzia dla programistów. Zawiera stały katalog domowy o pojemności 5 GB i działa w Google Cloud, co znacznie zwiększa wydajność sieci i uwierzytelnianie. Większość zadań w ramach tego ćwiczenia z programowania można wykonać w przeglądarce.

Po nawiązaniu połączenia z Cloud Shell powinno pojawić się potwierdzenie, że użytkownik jest uwierzytelniony, a projekt jest ustawiony na identyfikator Twojego projektu.

2. Uruchom to polecenie w Cloud Shell, aby potwierdzić, że jesteś uwierzytelniony:

gcloud auth list

Dane wyjściowe polecenia

 Credentialed Accounts
ACTIVE  ACCOUNT
*       <my_account>@<my_domain.com>

To set the active account, run:
    $ gcloud config set account `ACCOUNT`

Uwaga: narzędzie wiersza poleceń gcloud to zaawansowane, ujednolicone narzędzie wiersza poleceń w Google Cloud. Jest ona wstępnie zainstalowana w Cloud Shell. Zauważysz, że obsługuje ona funkcję autouzupełniania. Więcej informacji znajdziesz w artykule Omówienie narzędzia wiersza poleceń gcloud.

3. Uruchom to polecenie w Cloud Shell, aby sprawdzić, czy polecenie gcloud zna Twój projekt:

gcloud config list project

Dane wyjściowe polecenia

[core]
project = <PROJECT_ID>

Jeśli tak nie jest, możesz go ustawić za pomocą tego polecenia:

gcloud config set project <PROJECT_ID>

Dane wyjściowe polecenia

Updated property [core/project].

Uwaga: jeśli wykonujesz ten samouczek poza Cloud Shell, przeczytaj artykuł Konfigurowanie domyślnych danych logowania aplikacji.

3. Pobierz kod źródłowy

Po uruchomieniu Cloud Shell możesz w wierszu poleceń skopiować przykładowy kod źródłowy z katalogu głównego.

$ git clone https://github.com/spring-guides/gs-spring-boot.git
$ cd gs-spring-boot/complete

4. Uruchamianie aplikacji lokalnie

1. Sprawdź, czy ustawienie JAVA_HOME jest w prawidłowej wersji:

$ export JAVA_HOME=/usr/lib/jvm/java-1.17.0-openjdk-amd64

2. Aplikację Spring Boot możesz uruchomić w zwykły sposób, używając wtyczki Spring Boot.

$ ./mvnw -DskipTests spring-boot:run

3. Po uruchomieniu aplikacji kliknij Podgląd w przeglądarcena pasku narzędzi Cloud Shell i wybierz Podejrzyj na porcie 8080.

W przeglądarce zostanie otwarta karta i nawiążesz połączenie z właśnie uruchomionym serwerem.

5. Pakowanie aplikacji w Javie jako kontenera Dockera

Następnie musisz przygotować aplikację do działania w środowisku Kubernetes. Pierwszym krokiem jest zdefiniowanie kontenera i jego zawartości.

1. Utwórz plik JAR do wdrożenia dla aplikacji.

$ ./mvnw -DskipTests package

2. Włącz interfejs Artifact Registry API, aby zapisać utworzony obraz kontenera.

$ gcloud services enable artifactregistry.googleapis.com

3. Utwórz nowe repozytorium Dockera, jeśli takiego nie ma. Musisz utworzyć repozytorium, aby móc przekazać do niego obrazy:

$ gcloud artifacts repositories create codelabrepo     --repository-format=docker --location=us-central1 

4. Obraz będzie mieć następujący format:

{LOCATION}-docker.pkg.dev/{PROJECT-ID}/{REPOSITORY}/{IMAGE-NAME}

Jeśli na przykład utworzyłeś repozytorium w lokalizacji us-central1 o nazwie codelabrepo i chcesz nadać obrazowi nazwę hello-java:v1, obraz będzie miał taką nazwę:

us-central1-docker.pkg.dev/{PROJECT-ID}/codelabrepo/hello-java:v1

5. Utwórz obraz kontenera przy pomocy Jib i wypchnij go do Artifact Registry.

$ export GOOGLE_CLOUD_PROJECT=`gcloud config list --format="value(core.project)"`

$ ./mvnw -DskipTests com.google.cloud.tools:jib-maven-plugin:build -Dimage=us-central1-docker.pkg.dev/${GOOGLE_CLOUD_PROJECT}/codelabrepo/hello-java:v1

6. Wyświetlony obraz kontenera powinien być widoczny w konsoli po przejściu na stronę Artifacts Registry Images w konsoli Cloud. Teraz dostępny jest obraz Dockera dla całego projektu, do którego Kubernetes może uzyskać dostęp i administrować – jak to będzie widoczne za kilka minut.
7. (Opcjonalnie) Po zakończeniu (pobranie i wyodrębnienie wszystkich danych może trochę potrwać) przetestuj obraz za pomocą tego polecenia, które uruchomi kontener Dockera jako demona na porcie 8080 z nowo utworzonego obrazu kontenera. Jeśli napotkasz problemy z uprawnieniami, najpierw uruchom gcloud auth configure-docker us-central1-docker.pkg.dev:

$ docker run -ti --rm -p 8080:8080 \
  us-central1-docker.pkg.dev/$GOOGLE_CLOUD_PROJECT/codelabrepo/hello-java:v1

8. Jeszcze raz skorzystaj z dostępnej w Cloud Shell funkcji podglądu w przeglądarce.

9. W nowej karcie powinna wyświetlić się strona domyślna. Po sprawdzeniu, czy aplikacja działa lokalnie w kontenerze Dockera, możesz zatrzymać uruchomiony kontener, naciskając Control+C.

6. Tworzenie klastra

Możesz teraz utworzyć klaster GKE. Klaster składa się z serwera Kubernetes API zarządzanego przez Google i zbioru węzłów roboczych. Węzły robocze to maszyny wirtualne Compute Engine.

1. Najpierw sprawdź, czy powiązane funkcje interfejsu API są włączone.

$ gcloud services enable compute.googleapis.com container.googleapis.com

2. Utwórz klaster z 2 węzłami n1-standard-1 (ukończenie tego procesu może potrwać kilka minut).

$ gcloud container clusters create hello-java-cluster \
  --num-nodes 2 \
  --machine-type n1-standard-1 \
  --zone us-central1-c

Na koniec zobaczysz utworzony klaster.

Creating cluster hello-java-cluster...done.
Created [https://container.googleapis.com/v1/projects/...].
kubeconfig entry generated for hello-dotnet-cluster.
NAME                  ZONE            MASTER_VERSION  
hello-java-cluster  us-central1-c  ...

Uwaga: możesz też utworzyć klaster w konsoli Cloud. Aby ją otworzyć, kliknij Menu nawigacyjne > Kubernetes Engine > Klastry > Utwórz klaster. Możesz utworzyć klaster w innej strefie, ale zalecamy pozostawienie w tym samym regionie co zasobnik na dane używany przez Container Registry.

Teraz Twój klaster Kubernetes powinien być w pełni sprawny z użyciem technologii GKE.

Czas wdrożyć skonteneryzowaną aplikację w klastrze Kubernetes. Od teraz będziesz używać wiersza poleceń kubectl (jest on już skonfigurowany w Twoim środowisku Cloud Shell). Pozostała część ćwiczeń w Codelabs wymaga, aby klient i serwer Kubernetes były w wersji 1.2 lub nowszej. kubectl version pokaże Ci bieżącą wersję polecenia.

7. Wdrażanie aplikacji w Kubernetes

1. Wdrożenie Kubernetes może korzystać z utworzonego przez Ciebie obrazu kontenera, aby tworzyć i skalować wiele instancji Twojej aplikacji oraz nimi zarządzać. Wdróż instancję aplikacji w Kubernetes za pomocą polecenia kubectl run.

$ kubectl create deployment hello-java --image=us-central1-docker.pkg.dev/$GOOGLE_CLOUD_PROJECT/codelabrepo/hello-java:v1

2. Aby wyświetlić utworzone wdrożenie, wystarczy uruchomić to polecenie:

$ kubectl get deployments

NAME         DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
hello-java   1         1         1            1           37s

3. Aby wyświetlić instancje aplikacji utworzone przez wdrożenie, uruchom to polecenie:

$ kubectl get pods

NAME                         READY     STATUS    RESTARTS   AGE
hello-java-714049816-ztzrb   1/1       Running   0          57s

W tym momencie kontener powinien działać pod kontrolą Kubernetes, ale nadal musisz udostępnić go światu zewnętrznemu.

8. Zezwalaj na ruch zewnętrzny

Domyślnie pod jest dostępny tylko przez jego wewnętrzny adres IP w klastrze. Aby umożliwić dostęp do kontenera hello-java spoza wirtualnej sieci Kubernetes, musisz udostępnić poda jako usługę Kubernetes.

1. W Cloud Shell możesz udostępnić poda w publicznym internecie, tworząc usługę Kubernetes LoadBalancer.

$ kubectl create service loadbalancer hello-java --tcp=8080:8080

Pamiętaj, że bezpośrednio udostępniasz wdrożenie, a nie pod. Spowoduje to równoważenie obciążenia ruchu generowanego przez powstałą usługę we wszystkich podach zarządzanych przez wdrożenie (w tym przypadku tylko 1 pod, ale później dodasz więcej replik).

Master Kubernetes tworzy system równoważenia obciążenia i powiązane reguły przekierowania Compute Engine, pule docelowe i reguły zapory sieciowej, aby zapewnić pełną dostępność usługi spoza Google Cloud.

2. Aby znaleźć publicznie dostępny adres IP usługi, wyślij żądanie kubectl do listy wszystkich usług klastra.

$ kubectl get services

NAME         CLUSTER-IP     EXTERNAL-IP      PORT(S)    AGE
hello-java   10.3.253.62    aaa.bbb.ccc.ddd  8080/TCP    1m
kubernetes   10.3.240.1     <none>           443/TCP    5m

Uwaga: może minąć kilka minut, zanim EXTERNAL-IP stanie się dostępny i widoczny. Jeśli nie ma EXTERNAL-IP, poczekaj kilka minut i spróbuj ponownie.

3. Usługa powinna być teraz dostępna, jeśli otworzysz w przeglądarce stronę http://<EXTERNAL_IP>:8080.

9. Skaluj usługi

Jedną z zaawansowanych funkcji platformy Kubernetes jest łatwość skalowania aplikacji. Załóżmy, że nagle potrzebujesz większej pojemności aplikacji. Możesz po prostu zlecić kontrolerowi replikacji zarządzanie nową liczbą replik instancji aplikacji.

$ kubectl scale deployment hello-java --replicas=3

deployment "hello-java" scaled

$ kubectl get deployment
NAME         DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
hello-java   3         3         3            3           22m

Zwróć uwagę na podejście deklaratywne. Zamiast uruchamiać lub zatrzymywać nowe instancje, musisz zadeklarować, ile instancji powinno być uruchomionych przez cały czas. Pętle uzgadniania Kubernetes po prostu dbają o to, aby rzeczywistość była zgodna z żądaniami i w razie potrzeby podjęto odpowiednie działania.

10. Wdrażanie uaktualnienia usługi

Aplikacja wdrożona w wersji produkcyjnej będzie czasami wymagała poprawek błędów lub dodatkowych funkcji. Kubernetes może pomóc we wdrożeniu nowej wersji w środowisku produkcyjnym bez wpływu na użytkowników.

1. Otwórz edytor kodu, klikając Otwórz edytor w menu Cloud Shell.
2. Przejdź do zadania src/main/java/com/example/springboot/HelloController.java i zaktualizuj wartość odpowiedzi.

package com.example.springboot;

import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestMapping;

@RestController
public class HelloController {

    @RequestMapping("/")
    public String index() {
        return "Greetings from Google Kubernetes Engine!";
    }
}

3. Użyj Jib, aby skompilować i wypchnąć nową wersję obrazu kontenera. Tworzenie i przekazywanie zaktualizowanego obrazu powinno być znacznie szybsze, ponieważ pozwala to w pełni wykorzystać pamięć podręczną.

$ ./mvnw -DskipTests package com.google.cloud.tools:jib-maven-plugin:build -Dimage=us-central1-docker.pkg.dev/$GOOGLE_CLOUD_PROJECT/codelabrepo/hello-java:v2

Teraz Kubernetes może sprawnie zaktualizować kontroler replikacji do nowej wersji aplikacji.

4. Aby zmienić etykietę obrazu aktywnego kontenera, zmodyfikuj bieżące wdrożenie hello-java i zmień obraz z us-central1-docker.pkg.dev/PROJECT_ID/codelabrepo/hello-java:v1

do: us-central1-docker.pkg.dev/PROJECT_ID/codelabrepo/hello-java:v2

5. Możesz użyć polecenia kubectl set image, aby poprosić Kubernetes o wdrożenie nowej wersji Twojej aplikacji w całym klastrze pojedynczo z aktualizacjami kroczącymi.

$ kubectl set image deployment/hello-java hello-java=us-central1-docker.pkg.dev/$GOOGLE_CLOUD_PROJECT/codelabrepo/hello-java:v2

deployment "hello-java" image updated

Uwaga: w międzyczasie użytkownicy usług mogą zauważyć przerwy w działaniu usług, ale dzieje się tak, ponieważ nie skonfigurowano kontroli stanu. To nieco bardziej zaawansowana konfiguracja, która wykracza poza zakres ćwiczeń z programowania.

6. Sprawdź ponownie, czy funkcja http://EXTERNAL_IP:8080 zwraca nową odpowiedź.

11. Wycofaj zmiany

Ups… Czy popełniłeś błąd w nowej wersji aplikacji? Być może nowa wersja zawiera błąd i musisz szybko ją przywrócić. W Kubernetes można łatwo przywrócić poprzedni stan. Przywróć aplikację, uruchamiając to polecenie:

$ kubectl rollout undo deployment/hello-java

Stara odpowiedź powinna pojawić się, gdy ponownie sprawdzisz zadanie http://EXTERNAL_IP:8080.

12. Gratulacje

Udało Ci się utworzyć i wdrożyć nową aplikację internetową w języku Java w Kubernetes w GKE.

Czyszczenie danych

$ gcloud container clusters delete hello-java-cluster --zone us-central1-c

$ gcloud container images delete us-central1-docker.pkg.dev/$GOOGLE_CLOUD_PROJECT/codelabrepo/hello-java:v1 us-central1-docker.pkg.dev/$GOOGLE_CLOUD_PROJECT/codelabrepo/hello-java:v2

Więcej informacji

• Java w Google Cloud
• Przykładowy kod w języku Java
• Kubernetes w GKE – od podstaw po zaawansowane