Udostępnij za pośrednictwem

Microsoft.KubernetesConfiguration fluxConfigurations 2022-03-01

  • Artykuł

Definicja zasobu Bicep

Typ zasobu fluxConfigurations można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.KubernetesConfiguration/fluxConfigurations, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.KubernetesConfiguration/fluxConfigurations@2022-03-01' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    bucket: {
      accessKey: 'string'
      bucketName: 'string'
      insecure: bool
      localAuthRef: 'string'
      syncIntervalInSeconds: int
      timeoutInSeconds: int
      url: 'string'
    }
    configurationProtectedSettings: {
      {customized property}: 'string'
    }
    gitRepository: {
      httpsCACert: 'string'
      httpsUser: 'string'
      localAuthRef: 'string'
      repositoryRef: {
        branch: 'string'
        commit: 'string'
        semver: 'string'
        tag: 'string'
      }
      sshKnownHosts: 'string'
      syncIntervalInSeconds: int
      timeoutInSeconds: int
      url: 'string'
    }
    kustomizations: {
      {customized property}: {
        dependsOn: [
          'string'
        ]
        force: bool
        path: 'string'
        prune: bool
        retryIntervalInSeconds: int
        syncIntervalInSeconds: int
        timeoutInSeconds: int
      }
    }
    namespace: 'string'
    scope: 'string'
    sourceKind: 'string'
    suspend: bool
  }
}

Wartości właściwości

ZasobnikDefinition

Nazwa Opis Wartość
accessKey Klucz dostępu w postaci zwykłego tekstu używany do bezpiecznego uzyskiwania dostępu do zasobnika S3 struna
bucketName Nazwa zasobnika do synchronizacji z punktu końcowego adresu URL dla konfiguracji strumienia. struna
niepewny Określ, czy podczas stosowania niezabezpieczonej komunikacji dane z zasobnika S3 mają być używane. Bool
localAuthRef Nazwa lokalnego wpisu tajnego w klastrze Kubernetes, który ma być używany jako wpis tajny uwierzytelniania, a nie zarządzanych lub udostępnianych przez użytkownika wpisów tajnych konfiguracji. struna
syncIntervalInSeconds Interwał ponownego uzgadniania źródła repozytorium git klastra ze zdalnym. Int
timeoutInSeconds Maksymalny czas próby uzgodnienia źródła repozytorium git klastra ze zdalnym. Int
adres URL Adres URL do synchronizacji zasobnika konfiguracji strumienia S3. struna

FluxConfigurationProperties

Nazwa Opis Wartość
wiadro Parametry do uzgadniania typu źródła zasobnika. BucketDefinition
configurationProtectedSettings Pary klucz-wartość ustawień konfiguracji chronionej dla konfiguracji FluxConfigurationPropertiesConfigurationProtectedSettings
gitRepository Parametry, które mają być uzgadniane z typem źródła repozytorium GitRepository. GitRepositoryDefinition
kustomizations Tablica kustomyzacji używanych do uzgadniania artefaktu pobranego przez typ źródłowy w klastrze. FluxConfigurationPropertiesKustomizations
Namespace Przestrzeń nazw, do której jest zainstalowana ta konfiguracja. Maksymalnie 253 małych liter alfanumeryczne znaki, łącznik i kropka. struna
zakres Zakres, w którym zostanie zainstalowany operator. "klaster"
"Przestrzeń nazw"
sourceKind Rodzaj źródła w celu ściągnięcia danych konfiguracji. "Zasobnik"
"GitRepository"
zawiesić Czy ta konfiguracja powinna zawiesić uzgadnianie jego kustomizations i źródeł. Bool

FluxConfigurationPropertiesConfigurationProtectedSettings

Nazwa Opis Wartość

FluxConfigurationPropertiesKustomizations

Nazwa Opis Wartość

GitRepositoryDefinition

Nazwa Opis Wartość
httpsCACert Zawartość urzędu certyfikacji HTTPS zakodowana w formacie Base64 używana do uzyskiwania dostępu do prywatnych repozytoriów git za pośrednictwem protokołu HTTPS struna
httpsUser Nazwa użytkownika protokołu HTTPS w postaci zwykłego tekstu używana do uzyskiwania dostępu do prywatnych repozytoriów git za pośrednictwem protokołu HTTPS struna
localAuthRef Nazwa lokalnego wpisu tajnego w klastrze Kubernetes, który ma być używany jako wpis tajny uwierzytelniania, a nie zarządzanych lub udostępnianych przez użytkownika wpisów tajnych konfiguracji. struna
repositoryRef Dokumentacja źródłowa obiektu GitRepository. RepositoryRefDefinition
sshKnownHosts Wartość known_hosts zakodowana w formacie Base64 zawierająca publiczne klucze SSH wymagane do uzyskania dostępu do prywatnych repozytoriów git za pośrednictwem protokołu SSH struna
syncIntervalInSeconds Interwał ponownego uzgadniania źródła repozytorium git klastra ze zdalnym. Int
timeoutInSeconds Maksymalny czas próby uzgodnienia źródła repozytorium git klastra ze zdalnym. Int
adres URL Adres URL do synchronizacji dla repozytorium git konfiguracji flux. struna

KustomizationDefinition

Nazwa Opis Wartość
dependsOn Określa inne kustomizations, od których zależy ta funkcja Kustomization. Ta synchronizacja Kustomization nie zostanie uzgodniona, dopóki wszystkie zależności nie wypełnią ich uzgodnień. string[]
siła Włączanie/wyłączanie ponownego tworzenia zasobów Kubernetes w klastrze w przypadku niepowodzenia stosowania poprawek z powodu niezmiennej zmiany pola. Bool
ścieżka Ścieżka w odwołaniu źródłowym do uzgodnienia w klastrze. struna
suszona śliwka Włączanie/wyłączanie odzyskiwania pamięci obiektów Kubernetes utworzonych przez tę funkcję Kustomization. Bool
retryIntervalInSeconds Interwał ponownego uzgadniania funkcji Kustomization w klastrze w przypadku awarii podczas uzgadniania. Int
syncIntervalInSeconds Interwał ponownego uzgadniania funkcji Kustomization w klastrze. Int
timeoutInSeconds Maksymalny czas próby uzgodnienia kustomyzacji w klastrze. Int

Microsoft.KubernetesConfiguration/fluxConfigurations

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości do utworzenia zasobu konfiguracji platformy Flux FluxConfigurationProperties
zakres Użyj polecenia podczas tworzenia zasobu w zakresie innym niż zakres wdrożenia. Ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia .

RepozytoriumRefDefinition

Nazwa Opis Wartość
gałąź Nazwa gałęzi repozytorium git do wyewidencjonowania. struna
popełnić Zatwierdzenie sha do wyewidencjonowania. Ta wartość musi być połączona z nazwą gałęzi, aby być prawidłowa. Ma to pierwszeństwo przed semver. struna
semver Zakres semver używany do dopasowania do tagów repozytorium git. Ma to pierwszeństwo przed tagiem. struna
znacznik Nazwa tagu repozytorium git do wyewidencjonowania. Ma to pierwszeństwo przed gałęzią. struna

Definicja zasobu szablonu usługi ARM

Typ zasobu fluxConfigurations można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.KubernetesConfiguration/fluxConfigurations, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.KubernetesConfiguration/fluxConfigurations",
  "apiVersion": "2022-03-01",
  "name": "string",
  "properties": {
    "bucket": {
      "accessKey": "string",
      "bucketName": "string",
      "insecure": "bool",
      "localAuthRef": "string",
      "syncIntervalInSeconds": "int",
      "timeoutInSeconds": "int",
      "url": "string"
    },
    "configurationProtectedSettings": {
      "{customized property}": "string"
    },
    "gitRepository": {
      "httpsCACert": "string",
      "httpsUser": "string",
      "localAuthRef": "string",
      "repositoryRef": {
        "branch": "string",
        "commit": "string",
        "semver": "string",
        "tag": "string"
      },
      "sshKnownHosts": "string",
      "syncIntervalInSeconds": "int",
      "timeoutInSeconds": "int",
      "url": "string"
    },
    "kustomizations": {
      "{customized property}": {
        "dependsOn": [ "string" ],
        "force": "bool",
        "path": "string",
        "prune": "bool",
        "retryIntervalInSeconds": "int",
        "syncIntervalInSeconds": "int",
        "timeoutInSeconds": "int"
      }
    },
    "namespace": "string",
    "scope": "string",
    "sourceKind": "string",
    "suspend": "bool"
  }
}

Wartości właściwości

ZasobnikDefinition

Nazwa Opis Wartość
accessKey Klucz dostępu w postaci zwykłego tekstu używany do bezpiecznego uzyskiwania dostępu do zasobnika S3 struna
bucketName Nazwa zasobnika do synchronizacji z punktu końcowego adresu URL dla konfiguracji strumienia. struna
niepewny Określ, czy podczas stosowania niezabezpieczonej komunikacji dane z zasobnika S3 mają być używane. Bool
localAuthRef Nazwa lokalnego wpisu tajnego w klastrze Kubernetes, który ma być używany jako wpis tajny uwierzytelniania, a nie zarządzanych lub udostępnianych przez użytkownika wpisów tajnych konfiguracji. struna
syncIntervalInSeconds Interwał ponownego uzgadniania źródła repozytorium git klastra ze zdalnym. Int
timeoutInSeconds Maksymalny czas próby uzgodnienia źródła repozytorium git klastra ze zdalnym. Int
adres URL Adres URL do synchronizacji zasobnika konfiguracji strumienia S3. struna

FluxConfigurationProperties

Nazwa Opis Wartość
wiadro Parametry do uzgadniania typu źródła zasobnika. BucketDefinition
configurationProtectedSettings Pary klucz-wartość ustawień konfiguracji chronionej dla konfiguracji FluxConfigurationPropertiesConfigurationProtectedSettings
gitRepository Parametry, które mają być uzgadniane z typem źródła repozytorium GitRepository. GitRepositoryDefinition
kustomizations Tablica kustomyzacji używanych do uzgadniania artefaktu pobranego przez typ źródłowy w klastrze. FluxConfigurationPropertiesKustomizations
Namespace Przestrzeń nazw, do której jest zainstalowana ta konfiguracja. Maksymalnie 253 małych liter alfanumeryczne znaki, łącznik i kropka. struna
zakres Zakres, w którym zostanie zainstalowany operator. "klaster"
"Przestrzeń nazw"
sourceKind Rodzaj źródła w celu ściągnięcia danych konfiguracji. "Zasobnik"
"GitRepository"
zawiesić Czy ta konfiguracja powinna zawiesić uzgadnianie jego kustomizations i źródeł. Bool

FluxConfigurationPropertiesConfigurationProtectedSettings

Nazwa Opis Wartość

FluxConfigurationPropertiesKustomizations

Nazwa Opis Wartość

GitRepositoryDefinition

Nazwa Opis Wartość
httpsCACert Zawartość urzędu certyfikacji HTTPS zakodowana w formacie Base64 używana do uzyskiwania dostępu do prywatnych repozytoriów git za pośrednictwem protokołu HTTPS struna
httpsUser Nazwa użytkownika protokołu HTTPS w postaci zwykłego tekstu używana do uzyskiwania dostępu do prywatnych repozytoriów git za pośrednictwem protokołu HTTPS struna
localAuthRef Nazwa lokalnego wpisu tajnego w klastrze Kubernetes, który ma być używany jako wpis tajny uwierzytelniania, a nie zarządzanych lub udostępnianych przez użytkownika wpisów tajnych konfiguracji. struna
repositoryRef Dokumentacja źródłowa obiektu GitRepository. RepositoryRefDefinition
sshKnownHosts Wartość known_hosts zakodowana w formacie Base64 zawierająca publiczne klucze SSH wymagane do uzyskania dostępu do prywatnych repozytoriów git za pośrednictwem protokołu SSH struna
syncIntervalInSeconds Interwał ponownego uzgadniania źródła repozytorium git klastra ze zdalnym. Int
timeoutInSeconds Maksymalny czas próby uzgodnienia źródła repozytorium git klastra ze zdalnym. Int
adres URL Adres URL do synchronizacji dla repozytorium git konfiguracji flux. struna

KustomizationDefinition

Nazwa Opis Wartość
dependsOn Określa inne kustomizations, od których zależy ta funkcja Kustomization. Ta synchronizacja Kustomization nie zostanie uzgodniona, dopóki wszystkie zależności nie wypełnią ich uzgodnień. string[]
siła Włączanie/wyłączanie ponownego tworzenia zasobów Kubernetes w klastrze w przypadku niepowodzenia stosowania poprawek z powodu niezmiennej zmiany pola. Bool
ścieżka Ścieżka w odwołaniu źródłowym do uzgodnienia w klastrze. struna
suszona śliwka Włączanie/wyłączanie odzyskiwania pamięci obiektów Kubernetes utworzonych przez tę funkcję Kustomization. Bool
retryIntervalInSeconds Interwał ponownego uzgadniania funkcji Kustomization w klastrze w przypadku awarii podczas uzgadniania. Int
syncIntervalInSeconds Interwał ponownego uzgadniania funkcji Kustomization w klastrze. Int
timeoutInSeconds Maksymalny czas próby uzgodnienia kustomyzacji w klastrze. Int

Microsoft.KubernetesConfiguration/fluxConfigurations

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2022-03-01'
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości do utworzenia zasobu konfiguracji platformy Flux FluxConfigurationProperties
typ Typ zasobu "Microsoft.KubernetesConfiguration/fluxConfigurations"

RepozytoriumRefDefinition

Nazwa Opis Wartość
gałąź Nazwa gałęzi repozytorium git do wyewidencjonowania. struna
popełnić Zatwierdzenie sha do wyewidencjonowania. Ta wartość musi być połączona z nazwą gałęzi, aby być prawidłowa. Ma to pierwszeństwo przed semver. struna
semver Zakres semver używany do dopasowania do tagów repozytorium git. Ma to pierwszeństwo przed tagiem. struna
znacznik Nazwa tagu repozytorium git do wyewidencjonowania. Ma to pierwszeństwo przed gałęzią. struna

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu fluxConfigurations można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.KubernetesConfiguration/fluxConfigurations, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KubernetesConfiguration/fluxConfigurations@2022-03-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      bucket = {
        accessKey = "string"
        bucketName = "string"
        insecure = bool
        localAuthRef = "string"
        syncIntervalInSeconds = int
        timeoutInSeconds = int
        url = "string"
      }
      configurationProtectedSettings = {
        {customized property} = "string"
      }
      gitRepository = {
        httpsCACert = "string"
        httpsUser = "string"
        localAuthRef = "string"
        repositoryRef = {
          branch = "string"
          commit = "string"
          semver = "string"
          tag = "string"
        }
        sshKnownHosts = "string"
        syncIntervalInSeconds = int
        timeoutInSeconds = int
        url = "string"
      }
      kustomizations = {
        {customized property} = {
          dependsOn = [
            "string"
          ]
          force = bool
          path = "string"
          prune = bool
          retryIntervalInSeconds = int
          syncIntervalInSeconds = int
          timeoutInSeconds = int
        }
      }
      namespace = "string"
      scope = "string"
      sourceKind = "string"
      suspend = bool
    }
  })
}

Wartości właściwości

ZasobnikDefinition

Nazwa Opis Wartość
accessKey Klucz dostępu w postaci zwykłego tekstu używany do bezpiecznego uzyskiwania dostępu do zasobnika S3 struna
bucketName Nazwa zasobnika do synchronizacji z punktu końcowego adresu URL dla konfiguracji strumienia. struna
niepewny Określ, czy podczas stosowania niezabezpieczonej komunikacji dane z zasobnika S3 mają być używane. Bool
localAuthRef Nazwa lokalnego wpisu tajnego w klastrze Kubernetes, który ma być używany jako wpis tajny uwierzytelniania, a nie zarządzanych lub udostępnianych przez użytkownika wpisów tajnych konfiguracji. struna
syncIntervalInSeconds Interwał ponownego uzgadniania źródła repozytorium git klastra ze zdalnym. Int
timeoutInSeconds Maksymalny czas próby uzgodnienia źródła repozytorium git klastra ze zdalnym. Int
adres URL Adres URL do synchronizacji zasobnika konfiguracji strumienia S3. struna

FluxConfigurationProperties

Nazwa Opis Wartość
wiadro Parametry do uzgadniania typu źródła zasobnika. BucketDefinition
configurationProtectedSettings Pary klucz-wartość ustawień konfiguracji chronionej dla konfiguracji FluxConfigurationPropertiesConfigurationProtectedSettings
gitRepository Parametry, które mają być uzgadniane z typem źródła repozytorium GitRepository. GitRepositoryDefinition
kustomizations Tablica kustomyzacji używanych do uzgadniania artefaktu pobranego przez typ źródłowy w klastrze. FluxConfigurationPropertiesKustomizations
Namespace Przestrzeń nazw, do której jest zainstalowana ta konfiguracja. Maksymalnie 253 małych liter alfanumeryczne znaki, łącznik i kropka. struna
zakres Zakres, w którym zostanie zainstalowany operator. "klaster"
"Przestrzeń nazw"
sourceKind Rodzaj źródła w celu ściągnięcia danych konfiguracji. "Zasobnik"
"GitRepository"
zawiesić Czy ta konfiguracja powinna zawiesić uzgadnianie jego kustomizations i źródeł. Bool

FluxConfigurationPropertiesConfigurationProtectedSettings

Nazwa Opis Wartość

FluxConfigurationPropertiesKustomizations

Nazwa Opis Wartość

GitRepositoryDefinition

Nazwa Opis Wartość
httpsCACert Zawartość urzędu certyfikacji HTTPS zakodowana w formacie Base64 używana do uzyskiwania dostępu do prywatnych repozytoriów git za pośrednictwem protokołu HTTPS struna
httpsUser Nazwa użytkownika protokołu HTTPS w postaci zwykłego tekstu używana do uzyskiwania dostępu do prywatnych repozytoriów git za pośrednictwem protokołu HTTPS struna
localAuthRef Nazwa lokalnego wpisu tajnego w klastrze Kubernetes, który ma być używany jako wpis tajny uwierzytelniania, a nie zarządzanych lub udostępnianych przez użytkownika wpisów tajnych konfiguracji. struna
repositoryRef Dokumentacja źródłowa obiektu GitRepository. RepositoryRefDefinition
sshKnownHosts Wartość known_hosts zakodowana w formacie Base64 zawierająca publiczne klucze SSH wymagane do uzyskania dostępu do prywatnych repozytoriów git za pośrednictwem protokołu SSH struna
syncIntervalInSeconds Interwał ponownego uzgadniania źródła repozytorium git klastra ze zdalnym. Int
timeoutInSeconds Maksymalny czas próby uzgodnienia źródła repozytorium git klastra ze zdalnym. Int
adres URL Adres URL do synchronizacji dla repozytorium git konfiguracji flux. struna

KustomizationDefinition

Nazwa Opis Wartość
dependsOn Określa inne kustomizations, od których zależy ta funkcja Kustomization. Ta synchronizacja Kustomization nie zostanie uzgodniona, dopóki wszystkie zależności nie wypełnią ich uzgodnień. string[]
siła Włączanie/wyłączanie ponownego tworzenia zasobów Kubernetes w klastrze w przypadku niepowodzenia stosowania poprawek z powodu niezmiennej zmiany pola. Bool
ścieżka Ścieżka w odwołaniu źródłowym do uzgodnienia w klastrze. struna
suszona śliwka Włączanie/wyłączanie odzyskiwania pamięci obiektów Kubernetes utworzonych przez tę funkcję Kustomization. Bool
retryIntervalInSeconds Interwał ponownego uzgadniania funkcji Kustomization w klastrze w przypadku awarii podczas uzgadniania. Int
syncIntervalInSeconds Interwał ponownego uzgadniania funkcji Kustomization w klastrze. Int
timeoutInSeconds Maksymalny czas próby uzgodnienia kustomyzacji w klastrze. Int

Microsoft.KubernetesConfiguration/fluxConfigurations

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. ciąg (wymagany)
Właściwości Właściwości do utworzenia zasobu konfiguracji platformy Flux FluxConfigurationProperties
typ Typ zasobu "Microsoft.KubernetesConfiguration/fluxConfigurations@2022-03-01"

RepozytoriumRefDefinition

Nazwa Opis Wartość
gałąź Nazwa gałęzi repozytorium git do wyewidencjonowania. struna
popełnić Zatwierdzenie sha do wyewidencjonowania. Ta wartość musi być połączona z nazwą gałęzi, aby być prawidłowa. Ma to pierwszeństwo przed semver. struna
semver Zakres semver używany do dopasowania do tagów repozytorium git. Ma to pierwszeństwo przed tagiem. struna
znacznik Nazwa tagu repozytorium git do wyewidencjonowania. Ma to pierwszeństwo przed gałęzią. struna