Integracja z wdrożeniem Kubernetes za pomocą Helm

Aplikacje hostowane w Kubernetes mogą uzyskać dostęp do danych w konfiguracji aplikacji , korzystając z biblioteki dostawcy App Configuration. Dostawca konfiguracji aplikacji posiada wbudowane możliwości buforowania i odświeżania, dzięki czemu aplikacje mogą korzystać z konfiguracji dynamicznej bez konieczności ponownego wdrażania. Jeśli wolisz nie aktualizować aplikacji, ten tutorial pokazuje, jak przenieść dane z konfiguracji aplikacji do Kubernetes, używając Helm podczas wdrożenia. Dzięki temu aplikacja może nadal uzyskiwać dostęp do konfiguracji na podstawie zmiennych i sekretów Kubernetes. Uruchom aktualizację Helm, gdy chcesz, aby aplikacja wykrywała zmiany konfiguracji.

Wskazówka

Zobacz opcje dla obciążeń uruchamianych w usłudze Kubernetes, aby uzyskać dostęp do usługi Azure App Configuration.

Program Helm umożliwia definiowanie, instalowanie i uaktualnianie aplikacji działających na platformie Kubernetes. Chart Helm zawiera informacje niezbędne do utworzenia instancji aplikacji w Kubernetes. Konfiguracja jest przechowywana poza samym wykresem w pliku o nazwie values.yaml.

Podczas procesu wydawania program Helm scala wykres z odpowiednią konfiguracją, aby uruchomić aplikację. Na przykład zmienne zdefiniowane w pliku values.yaml można odwoływać się jako zmienne środowiskowe wewnątrz uruchomionych kontenerów. Helm obsługuje również tworzenie obiektów Secret w Kubernetes, które mogą być montowane jako woluminy danych lub udostępniane jako zmienne środowiskowe.

Wartości przechowywane w pliku values.yaml można zastąpić, udostępniając dodatkowe pliki konfiguracji oparte na języku YAML w wierszu polecenia podczas uruchamiania programu Helm. aplikacja systemu Azure Configuration obsługuje eksportowanie wartości konfiguracji do plików YAML. Zintegrowanie tej możliwości eksportowania z wdrożeniem umożliwia aplikacjom Kubernetes wykorzystanie wartości konfiguracji przechowywanych w usłudze App Configuration.

Z tego samouczka dowiesz się, jak wykonywać następujące czynności:

  • Użyj wartości z usługi App Configuration podczas wdrażania aplikacji na platformie Kubernetes przy użyciu narzędzia Helm.
  • Utwórz klucz tajny Kubernetes na podstawie odwołania do magazynu Key Vault w usłudze App Configuration.

Ten samouczek zakłada podstawową znajomość zarządzania Kubernetes za pomocą Helm. Dowiedz się więcej na temat instalowania aplikacji za pomocą programu Helm w usłudze Azure Kubernetes Service.

Wymagania wstępne

Dodaj pary klucz-wartość

Dodaj następujące wartości klucza do magazynu App Configuration i pozostaw wartości Etykieta i Typ zawartości z ich wartościami domyślnymi. Aby uzyskać więcej informacji o tym, jak dodać pary klucz-wartość do magazynu przy użyciu portalu Azure lub interfejsu wiersza polecenia (CLI), przejdź do artykułu Create a key-value.

Klawisz Wartość
ustawienia.kolor Biały
settings.message Dane z usługi Azure App Configuration

Dodawanie odwołania do usługi Key Vault do usługi App Configuration

  1. Zaloguj się do portalu Azure i dodaj klucz tajny do magazynu Key Vault o nazwie Password i wartości myPassword.

  2. Wybierz wystąpienie sklepu App Configuration utworzone w poprzedniej sekcji.

  3. Wybierz Eksplorator konfiguracji.

  4. Wybierz + Utwórz>odwołanie do magazynu kluczy, a następnie określ następujące wartości:

    • Klucz: wybierz pozycję secrets.password.
    • Etykieta: pozostaw tę wartość pustą.
    • Subskrypcja, grupa zasobów i magazyn kluczy: wprowadź wartości odpowiadające wartościom w magazynie kluczy utworzonym w poprzednim kroku.
    • Wpis tajny: wybierz wpis tajny o nazwie Hasło utworzone w poprzedniej sekcji.

Tworzenie wykresu programu Helm

Najpierw utwórz przykładowy chart Helm za pomocą następującego polecenia:

helm create mychart

Program Helm tworzy nowy katalog o nazwie mychart ze strukturą pokazaną poniżej.

Wskazówka

Postępuj zgodnie z tym przewodnikiem dotyczącym wykresów, aby dowiedzieć się więcej.

mychart
|-- Chart.yaml
|-- charts
|-- templates
|   |-- NOTES.txt
|   |-- _helpers.tpl
|   |-- deployment.yaml
|   |-- ingress.yaml
|   `-- service.yaml
`-- values.yaml

Następnie zaktualizuj sekcję spec:template:spec:containers pliku deployment.yaml. Poniższy fragment kodu dodaje do kontenera dwie zmienne środowiskowe. Wartości będą ustawiane dynamicznie w czasie wdrażania.

env:
- name: Color
    value: {{ .Values.settings.color }}
- name: Message
    value: {{ .Values.settings.message }}

Kompletny plik deployment.yaml po aktualizacji powinien wyglądać następująco.

apiVersion: apps/v1beta2
kind: Deployment
metadata:
  name: {{ include "mychart.fullname" . }}
  labels:
    app.kubernetes.io/name: {{ include "mychart.name" . }}
    helm.sh/chart: {{ include "mychart.chart" . }}
    app.kubernetes.io/instance: {{ .Release.Name }}
    app.kubernetes.io/managed-by: {{ .Release.Service }}
spec:
  replicas: {{ .Values.replicaCount }}
  selector:
    matchLabels:
      app.kubernetes.io/name: {{ include "mychart.name" . }}
      app.kubernetes.io/instance: {{ .Release.Name }}
  template:
    metadata:
      labels:
        app.kubernetes.io/name: {{ include "mychart.name" . }}
        app.kubernetes.io/instance: {{ .Release.Name }}
    spec:
      containers:
        - name: {{ .Chart.Name }}
          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
          imagePullPolicy: {{ .Values.image.pullPolicy }}
          env:
            - name: Color
              value: {{ .Values.settings.color }}
            - name: Message
              value: {{ .Values.settings.message }}
          ports:
            - name: http
              containerPort: 80
              protocol: TCP
          livenessProbe:
            httpGet:
              path: /
              port: http
          readinessProbe:
            httpGet:
              path: /
              port: http
          resources:
{{ toYaml .Values.resources | indent 12 }}
    {{- with .Values.nodeSelector }}
      nodeSelector:
{{ toYaml . | indent 8 }}
    {{- end }}
    {{- with .Values.affinity }}
      affinity:
{{ toYaml . | indent 8 }}
    {{- end }}
    {{- with .Values.tolerations }}
      tolerations:
{{ toYaml . | indent 8 }}
    {{- end }}

Aby przechowywać poufne dane jako Sekrety Kubernetes, dodaj plik secrets.yaml w folderze templates.

Wskazówka

Dowiedz się więcej o tym, jak używać Kubernetes Secrets.

apiVersion: v1
kind: Secret
metadata:
  name: mysecret
type: Opaque
data:
  password: {{ .Values.secrets.password | b64enc }}

Na koniec zaktualizuj plik values.yaml, używając poniższej zawartości, aby opcjonalnie podać wartości domyślne ustawień konfiguracji i sekretów, do których odwołano się w plikach deployment.yaml i secrets.yaml. Ich rzeczywiste wartości zostaną zastąpione przez konfigurację pobraną z usługi App Configuration.

# settings will be overwritten by App Configuration
settings:
  color: red
  message: myMessage

Przekazywanie konfiguracji z konfiguracji aplikacji w instalacji programu Helm

Najpierw pobierz konfigurację z usługi App Configuration do pliku myConfig.yaml . Użyj filtru klucza, aby pobrać tylko te klucze, które zaczynają się od ustawień. Jeśli w Twoim przypadku filtr klucza nie jest wystarczający do wykluczenia kluczy odwołań usługi Key Vault, możesz użyć argumentu --skip-keyvault , aby je wykluczyć.

W poniższych przykładach zastąp tekst zastępczy <AppConfigurationStoreName> nazwą swojego magazynu App Configuration.

Wskazówka

Dowiedz się więcej o poleceniu export.

az appconfig kv export -n <AppConfigurationStoreName> -d file --path myConfig.yaml --key "settings.*"  --separator "." --format yaml

Następnie pobierz sekrety i zapisz je w pliku o nazwie mySecrets.yaml. Argument wiersza polecenia --resolve-keyvault rozwiązuje odwołania do usługi Key Vault przez pobranie rzeczywistych wartości z usługi Key Vault. To polecenie należy uruchomić przy użyciu poświadczeń, które mają uprawnienia dostępu do odpowiedniego magazynu Key Vault.

Ostrzeżenie

Ponieważ ten plik zawiera poufne informacje, zachowaj ostrożność i wyczyść plik, gdy nie jest już potrzebny.

az appconfig kv export -n <AppConfigurationStoreName> -d file --path mySecrets.yaml --key "secrets.*" --separator "." --resolve-keyvault --format yaml

Użyj argumentu -f polecenia helm upgrade, aby przekazać dwa utworzone wcześniej pliki konfiguracyjne. Zastąpią one wartości konfiguracji zdefiniowane w pliku values.yaml wartościami wyeksportowanymi z usługi App Configuration.

helm upgrade --install -f myConfig.yaml -f mySecrets.yaml "example" ./mychart

Możesz również użyć argumentu --set w poleceniu helm upgrade, aby przekazać literały klucz-wartość. Użycie argumentu --set jest dobrym sposobem na uniknięcie utrwalania poufnych danych na dysku.

$secrets = az appconfig kv list -n <AppConfigurationStoreName> --key "secrets.*" --resolve-keyvault --query "[*].{name:key, value:value}" | ConvertFrom-Json

foreach ($secret in $secrets) {
  $keyvalues += $secret.name + "=" + $secret.value + ","
}

if ($keyvalues){
  $keyvalues = $keyvalues.TrimEnd(',')
  helm upgrade --install --set $keyvalues "example" ./mychart
}
else{
  helm upgrade --install "example" ./mychart
}

Sprawdź, czy konfiguracje i sekrety zostały pomyślnie ustawione, uzyskując dostęp do Dashboardu Kubernetes. Zobaczysz, że wartości color i message z usługi App Configuration zostały przypisane do zmiennych środowiskowych kontenera.

Szybki start — lokalne uruchamianie aplikacji

Jeden sekret, hasło, przechowywany jako odwołanie do usługi Key Vault w usłudze App Configuration, został również dodany do Sekretów Kubernetes.

Zrzut ekranu z wyróżnionym hasłem w sekcji Dane.

Czyszczenie zasobów

Jeśli nie chcesz nadal korzystać z zasobów utworzonych w tym artykule, usuń utworzoną tutaj grupę zasobów, aby uniknąć naliczania opłat.

Ważne

Usunięcie grupy zasobów jest nieodwracalne. Grupa zasobów i wszystkie zasoby w niej są trwale usuwane. Upewnij się, że nie usuniesz przypadkowo nieprawidłowej grupy zasobów ani zasobów. Jeśli zasoby dla tego artykułu zostały utworzone w grupie zasobów zawierającej inne zasoby, które chcesz zachować, usuń każdy zasób oddzielnie z odpowiedniego okienka zamiast usuwać grupę zasobów.

  1. Zaloguj się do witryny Azure Portal i wybierz pozycję Grupy zasobów.
  2. W polu Filtruj według nazwy wprowadź nazwę grupy zasobów.
  3. Na liście wyników wybierz nazwę grupy zasobów, aby wyświetlić przegląd.
  4. Wybierz pozycję Usuń grupę zasobów.
  5. Zostaniesz poproszony o potwierdzenie usunięcia grupy zasobów. Wprowadź nazwę grupy zasobów, aby potwierdzić, a następnie wybierz pozycję Usuń.

Po kilku chwilach grupa zasobów i wszystkie jej zasoby zostaną usunięte.

Następne kroki

W tym samouczku wyeksportowano dane usługi Azure App Configuration do użycia podczas wdrożenia Kubernetes przy użyciu narzędzia Helm. Aby dowiedzieć się więcej na temat korzystania z usługi App Configuration, przejdź do przykładów interfejsu wiersza polecenia platformy Azure.