Microsoft. KubernetesConfiguration fluxConfigurations

  • Článek

Definice prostředku Bicep

Typ prostředku fluxConfigurations je prostředek rozšíření, což znamená, že ho můžete použít na jiný prostředek.

scope Pomocí vlastnosti tohoto prostředku nastavte obor tohoto prostředku. Viz Nastavení oboru u prostředků rozšíření v Bicepu.

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Vytvoření Microsoft. Prostředek KubernetesConfiguration/fluxConfigurations přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.KubernetesConfiguration/fluxConfigurations@2022-11-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    azureBlob: {
      accountKey: 'string'
      containerName: 'string'
      localAuthRef: 'string'
      managedIdentity: {
        clientId: 'string'
      }
      sasToken: 'string'
      servicePrincipal: {
        clientCertificate: 'string'
        clientCertificatePassword: 'string'
        clientCertificateSendChain: bool
        clientId: 'string'
        clientSecret: 'string'
        tenantId: 'string'
      }
      syncIntervalInSeconds: int
      timeoutInSeconds: int
      url: 'string'
    }
    bucket: {
      accessKey: 'string'
      bucketName: 'string'
      insecure: bool
      localAuthRef: 'string'
      syncIntervalInSeconds: int
      timeoutInSeconds: int
      url: 'string'
    }
    configurationProtectedSettings: {}
    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: {}
    namespace: 'string'
    scope: 'string'
    sourceKind: 'string'
    suspend: bool
  }
}

Hodnoty vlastností

fluxConfigurations

Název Description Hodnota
name Název prostředku string (povinné)
scope Použijte při vytváření prostředku rozšíření v oboru, který se liší od oboru nasazení. Cílový prostředek

Pro Bicep nastavte tuto vlastnost na symbolický název prostředku, aby se použil prostředek rozšíření.
properties Vlastnosti pro vytvoření prostředku konfigurace flux FluxConfigurationProperties

FluxConfigurationProperties

Název Description Hodnota
azureBlob Parametry, které se mají sladit s typem zdroje AzureBlob. AzureBlobDefinition
Kbelík Parametry, které se mají sladit s typem zdroje Kbelík. BucketDefinition
configurationProtectedSettings Páry klíč-hodnota nastavení chráněné konfigurace pro konfiguraci object
gitRepository Parametry, které se mají sladit s typem zdrojového typu GitRepository GitRepositoryDefinition
kustomizace Pole kustomizací sloužících k odsouhlasení artefaktu nataženého typem zdroje v clusteru. object
namespace Obor názvů, do kterého je tato konfigurace nainstalována. Maximálně 253 malých alfanumerických znaků, pouze spojovník a tečka. řetězec
scope Obor, ve kterém bude operátor nainstalován. 'cluster'
'obor názvů'
sourceKind Druh zdroje, ze které chcete získat konfigurační data. AzureBlob
'Kbelík'
GitRepository
pozastavit Jestli má tato konfigurace pozastavit své odsouhlasení kustomizace a zdrojů. bool

AzureBlobDefinition

Název Description Hodnota
accountKey Klíč účtu (sdílený klíč) pro přístup k účtu úložiště řetězec
název_kontejneru Název kontejneru azure blob, který se má synchronizovat z koncového bodu adresy URL pro konfiguraci flux. řetězec
localAuthRef Název místního tajného klíče v clusteru Kubernetes, který se použije jako ověřovací tajný klíč místo spravovaných nebo uživatelem poskytnutých konfiguračních tajných kódů. řetězec
managedIdentity Parametry pro ověřování pomocí spravované identity ManagedIdentityDefinition
sasToken Token sdíleného přístupu pro přístup ke kontejneru úložiště řetězec
servicePrincipal Parametry pro ověřování pomocí instančního objektu. ServicePrincipalDefinition
syncIntervalInSeconds Interval, ve kterém se má znovu sloučit zdroj objektů blob clusteru Azure se vzdáleným. int
timeoutInSeconds Maximální doba pokusu o odsouhlasení zdroje clusteru Azure Blob se vzdáleným. int
url Adresa URL pro synchronizaci konfiguračního účtu služby Azure Blob Storage. řetězec

ManagedIdentityDefinition

Název Description Hodnota
clientId ID klienta pro ověřování spravované identity. řetězec

ServicePrincipalDefinition

Název Description Hodnota
clientCertificate Certifikát s kódováním Base64 použitý k ověření instančního objektu řetězec
clientCertificatePassword Heslo k certifikátu použitému k ověření instančního objektu řetězec
clientCertificateSendChain Určuje, jestli se má při získávání tokenu zahrnout hlavička x5c do deklarací identity klienta, aby se povolilo ověřování na základě názvu subjektu nebo vystavitele pro klientský certifikát. bool
clientId ID klienta pro ověřování instančního objektu. řetězec
clientSecret Tajný klíč klienta pro ověřování instančního objektu řetězec
id tenanta ID tenanta pro ověřování instančního objektu řetězec

BucketDefinition

Název Description Hodnota
Accesskey Přístupový klíč ve formátu prostého textu používaný k bezpečnému přístupu k kbelíku S3 řetězec
bucketName Název kontejneru, který se má synchronizovat z koncového bodu adresy URL pro konfiguraci toku. řetězec
Nejistá Určete, jestli se má používat nezabezpečená komunikace při pučení dat z kbelíku S3. bool
localAuthRef Název místního tajného klíče v clusteru Kubernetes, který se použije jako ověřovací tajný klíč místo spravovaných nebo uživatelem poskytnutých konfiguračních tajných kódů. řetězec
syncIntervalInSeconds Interval, ve kterém se má zdroj kontejneru clusteru znovu sloučit se vzdáleným. int
timeoutInSeconds Maximální doba pokusu o odsouhlasení zdroje kontejneru clusteru se vzdáleným. int
url Adresa URL pro synchronizaci kontejneru S3 konfigurace flux. řetězec

GitRepositoryDefinition

Název Description Hodnota
httpsCACert Obsah certifikační autority HTTPS s kódováním Base64, který slouží k přístupu k privátním úložištím Git přes HTTPS řetězec
httpsUser Uživatelské jméno HTTPS ve formátu prostého textu, které se používá pro přístup k privátním úložištím Git přes HTTPS řetězec
localAuthRef Název místního tajného klíče v clusteru Kubernetes, který se použije jako ověřovací tajný klíč místo spravovaných nebo uživatelem poskytnutých konfiguračních tajných kódů. řetězec
repositoryRef Referenční informace ke zdroji objektu GitRepository RepositoryRefDefinition
sshKnownHosts Hodnota known_hosts kódování Base64 obsahující veřejné klíče SSH vyžadované pro přístup k privátním úložištím Git přes SSH řetězec
syncIntervalInSeconds Interval, ve kterém se má znovu sloučit zdroj úložiště Git clusteru se vzdáleným úložištěm. int
timeoutInSeconds Maximální doba pokusu o odsouhlasení zdroje úložiště Git clusteru se vzdáleným úložištěm int
url Adresa URL, která se má synchronizovat pro úložiště Git konfigurace flux. řetězec

RepositoryRefDefinition

Název Description Hodnota
branch Název větve úložiště Git, který chcete rezervovat. řetězec
Spáchat Potvrzení sha k rezervaci Tato hodnota musí být kombinována s názvem větve, aby byla platná. To má přednost před semver. řetězec
semver Rozsah semveru použitý ke shodě se značkami úložiště Git. To má přednost před značkou. řetězec
značka Název značky úložiště Git, který chcete rezervovat. To má přednost před větví. řetězec

Definice prostředku šablony ARM

Typ prostředku fluxConfigurations je prostředek rozšíření, což znamená, že ho můžete použít na jiný prostředek.

scope Pomocí vlastnosti tohoto prostředku nastavte obor tohoto prostředku. Viz Nastavení oboru u prostředků rozšíření v šablonách ARM.

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Vytvoření Microsoft. Prostředek KubernetesConfiguration/fluxConfigurations přidejte do šablony následující kód JSON.

{
  "type": "Microsoft.KubernetesConfiguration/fluxConfigurations",
  "apiVersion": "2022-11-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "azureBlob": {
      "accountKey": "string",
      "containerName": "string",
      "localAuthRef": "string",
      "managedIdentity": {
        "clientId": "string"
      },
      "sasToken": "string",
      "servicePrincipal": {
        "clientCertificate": "string",
        "clientCertificatePassword": "string",
        "clientCertificateSendChain": "bool",
        "clientId": "string",
        "clientSecret": "string",
        "tenantId": "string"
      },
      "syncIntervalInSeconds": "int",
      "timeoutInSeconds": "int",
      "url": "string"
    },
    "bucket": {
      "accessKey": "string",
      "bucketName": "string",
      "insecure": "bool",
      "localAuthRef": "string",
      "syncIntervalInSeconds": "int",
      "timeoutInSeconds": "int",
      "url": "string"
    },
    "configurationProtectedSettings": {},
    "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": {},
    "namespace": "string",
    "scope": "string",
    "sourceKind": "string",
    "suspend": "bool"
  }
}

Hodnoty vlastností

fluxConfigurations

Název Description Hodnota
typ Typ prostředku 'Microsoft. KubernetesConfiguration/fluxConfigurations
apiVersion Verze rozhraní API prostředků '2022-11-01'
name Název prostředku string (povinné)
scope Použijte při vytváření prostředku rozšíření v oboru, který se liší od oboru nasazení. Cílový prostředek

Pro JSON nastavte hodnotu na úplný název prostředku, na který chcete prostředek rozšíření použít.
properties Vlastnosti pro vytvoření prostředku konfigurace flux FluxConfigurationProperties

FluxConfigurationProperties

Název Description Hodnota
azureBlob Parametry, které se mají sladit s typem zdroje AzureBlob. AzureBlobDefinition
Kbelík Parametry, které se mají sladit s typem zdroje Kbelík. BucketDefinition
configurationProtectedSettings Páry klíč-hodnota nastavení chráněné konfigurace pro konfiguraci object
gitRepository Parametry, které se mají sladit s typem zdrojového typu GitRepository GitRepositoryDefinition
kustomizace Pole kustomizací sloužících k odsouhlasení artefaktu nataženého typem zdroje v clusteru. object
namespace Obor názvů, do kterého je tato konfigurace nainstalována. Maximálně 253 malých alfanumerických znaků, pouze spojovník a tečka. řetězec
scope Obor, ve kterém bude operátor nainstalován. 'cluster'
'obor názvů'
sourceKind Druh zdroje, ze které chcete získat konfigurační data. AzureBlob
'Kbelík'
GitRepository
pozastavit Jestli má tato konfigurace pozastavit své odsouhlasení kustomizace a zdrojů. bool

AzureBlobDefinition

Název Description Hodnota
accountKey Klíč účtu (sdílený klíč) pro přístup k účtu úložiště řetězec
název_kontejneru Název kontejneru azure blob, který se má synchronizovat z koncového bodu adresy URL pro konfiguraci flux. řetězec
localAuthRef Název místního tajného klíče v clusteru Kubernetes, který se použije jako ověřovací tajný klíč místo spravovaných nebo uživatelem poskytnutých konfiguračních tajných kódů. řetězec
managedIdentity Parametry pro ověřování pomocí spravované identity ManagedIdentityDefinition
sasToken Token sdíleného přístupu pro přístup ke kontejneru úložiště řetězec
servicePrincipal Parametry pro ověřování pomocí instančního objektu. ServicePrincipalDefinition
syncIntervalInSeconds Interval, ve kterém se má znovu sloučit zdroj objektů blob clusteru Azure se vzdáleným. int
timeoutInSeconds Maximální doba pokusu o odsouhlasení zdroje clusteru Azure Blob se vzdáleným. int
url Adresa URL pro synchronizaci konfiguračního účtu služby Azure Blob Storage. řetězec

ManagedIdentityDefinition

Název Description Hodnota
clientId ID klienta pro ověřování spravované identity. řetězec

ServicePrincipalDefinition

Název Description Hodnota
clientCertificate Certifikát s kódováním Base64 použitý k ověření instančního objektu řetězec
clientCertificatePassword Heslo k certifikátu použitému k ověření instančního objektu řetězec
clientCertificateSendChain Určuje, jestli se má při získávání tokenu zahrnout hlavička x5c do deklarací identity klienta, aby se povolilo ověřování na základě názvu subjektu nebo vystavitele pro klientský certifikát. bool
clientId ID klienta pro ověřování instančního objektu. řetězec
clientSecret Tajný klíč klienta pro ověřování instančního objektu řetězec
id tenanta ID tenanta pro ověřování instančního objektu řetězec

BucketDefinition

Název Description Hodnota
Accesskey Přístupový klíč ve formátu prostého textu používaný k bezpečnému přístupu k kbelíku S3 řetězec
bucketName Název kontejneru, který se má synchronizovat z koncového bodu adresy URL pro konfiguraci toku. řetězec
Nejistá Určete, jestli se má používat nezabezpečená komunikace při pučení dat z kbelíku S3. bool
localAuthRef Název místního tajného klíče v clusteru Kubernetes, který se použije jako ověřovací tajný klíč místo spravovaných nebo uživatelem poskytnutých konfiguračních tajných kódů. řetězec
syncIntervalInSeconds Interval, ve kterém se má zdroj kontejneru clusteru znovu sloučit se vzdáleným. int
timeoutInSeconds Maximální doba pokusu o odsouhlasení zdroje kontejneru clusteru se vzdáleným. int
url Adresa URL pro synchronizaci kontejneru S3 konfigurace flux. řetězec

GitRepositoryDefinition

Název Description Hodnota
httpsCACert Obsah certifikační autority HTTPS s kódováním Base64, který slouží k přístupu k privátním úložištím Git přes HTTPS řetězec
httpsUser Uživatelské jméno HTTPS ve formátu prostého textu, které se používá pro přístup k privátním úložištím Git přes HTTPS řetězec
localAuthRef Název místního tajného klíče v clusteru Kubernetes, který se použije jako ověřovací tajný klíč místo spravovaných nebo uživatelem poskytnutých konfiguračních tajných kódů. řetězec
repositoryRef Referenční informace ke zdroji objektu GitRepository RepositoryRefDefinition
sshKnownHosts Hodnota known_hosts kódování Base64 obsahující veřejné klíče SSH vyžadované pro přístup k privátním úložištím Git přes SSH řetězec
syncIntervalInSeconds Interval, ve kterém se má znovu sloučit zdroj úložiště Git clusteru se vzdáleným úložištěm. int
timeoutInSeconds Maximální doba pokusu o odsouhlasení zdroje úložiště Git clusteru se vzdáleným úložištěm int
url Adresa URL, která se má synchronizovat pro úložiště Git konfigurace flux. řetězec

RepositoryRefDefinition

Název Description Hodnota
branch Název větve úložiště Git, který chcete rezervovat. řetězec
Spáchat Potvrzení sha k rezervaci Tato hodnota musí být kombinována s názvem větve, aby byla platná. To má přednost před semver. řetězec
semver Rozsah semveru použitý ke shodě se značkami úložiště Git. To má přednost před značkou. řetězec
značka Název značky úložiště Git, který chcete rezervovat. To má přednost před větví. řetězec

Definice prostředku Terraformu (zprostředkovatele AzAPI)

Typ prostředku fluxConfigurations je prostředek rozšíření, což znamená, že ho můžete použít na jiný prostředek.

parent_id Pomocí vlastnosti tohoto prostředku nastavte obor tohoto prostředku.

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Vytvoření Microsoft. Prostředek KubernetesConfiguration/fluxConfigurations, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KubernetesConfiguration/fluxConfigurations@2022-11-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      azureBlob = {
        accountKey = "string"
        containerName = "string"
        localAuthRef = "string"
        managedIdentity = {
          clientId = "string"
        }
        sasToken = "string"
        servicePrincipal = {
          clientCertificate = "string"
          clientCertificatePassword = "string"
          clientCertificateSendChain = bool
          clientId = "string"
          clientSecret = "string"
          tenantId = "string"
        }
        syncIntervalInSeconds = int
        timeoutInSeconds = int
        url = "string"
      }
      bucket = {
        accessKey = "string"
        bucketName = "string"
        insecure = bool
        localAuthRef = "string"
        syncIntervalInSeconds = int
        timeoutInSeconds = int
        url = "string"
      }
      configurationProtectedSettings = {}
      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 = {}
      namespace = "string"
      scope = "string"
      sourceKind = "string"
      suspend = bool
    }
  })
}

Hodnoty vlastností

fluxConfigurations

Název Description Hodnota
typ Typ prostředku "Microsoft. KubernetesConfiguration/fluxConfigurations@2022-11-01"
name Název prostředku string (povinné)
parent_id ID prostředku, na který se má tento prostředek rozšíření použít. string (povinné)
properties Vlastnosti pro vytvoření prostředku konfigurace Flux FluxConfigurationVlastnosti

FluxConfigurationVlastnosti

Název Description Hodnota
azureBlob Parametry, které se mají odsouhlasit s typem zdroje AzureBlob AzureBlobDefinition
Kbelík Parametry, které se mají sladit s typem zdroje Kbelík. BucketDefinition
configurationProtectedSettings Páry klíč-hodnota chráněných nastavení konfigurace pro konfiguraci object
gitRepository Parametry pro odsouhlasení s typem druhu zdroje GitRepository GitRepositoryDefinition
kustomizace Pole kustomizace sloužící k odsouhlasení artefaktu nataženého typem zdroje v clusteru. object
namespace Obor názvů, do kterého je tato konfigurace nainstalována. Maximálně 253 malých alfanumerických znaků, spojovníku a tečky. řetězec
scope Obor, ve kterém se operátor nainstaluje. "cluster"
"obor názvů"
sourceKind Druh zdroje, ze které se mají vyžádat konfigurační data. "AzureBlob"
"Kbelík"
"GitRepository"
pozastavit Jestli má tato konfigurace pozastavit své odsouhlasení kustomizace a zdrojů. bool

AzureBlobDefinition

Název Description Hodnota
accountKey Klíč účtu (sdílený klíč) pro přístup k účtu úložiště řetězec
název_kontejneru Název kontejneru objektů blob Azure, který se má synchronizovat z koncového bodu adresy URL pro konfiguraci flux. řetězec
localAuthRef Název místního tajného klíče v clusteru Kubernetes, který se použije jako ověřovací tajný klíč místo spravovaných nebo uživatelem poskytnutých tajných kódů konfigurace. řetězec
spravovaná identita Parametry pro ověřování pomocí spravované identity Definice spravované identity
houstoken Token sdíleného přístupu pro přístup ke kontejneru úložiště řetězec
servicePrincipal Parametry pro ověřování pomocí instančního objektu ServicePrincipalDefinition
syncIntervalInSeconds Interval, ve kterém se má zdroj azure blob clusteru znovu odsouhlasit se vzdáleným. int
timeoutInSeconds Maximální doba potřebná k pokusu o odsouhlasení zdroje azure blob clusteru se vzdáleným úložištěm. int
url Adresa URL pro synchronizaci konfiguračního účtu Azure Blob Storage. řetězec

Definice spravované identity

Název Description Hodnota
clientId ID klienta pro ověřování spravované identity. řetězec

ServicePrincipalDefinition

Název Description Hodnota
clientCertificate Certifikát kódovaný jako Base64 používaný k ověření instančního objektu řetězec
clientCertificatePassword Heslo k certifikátu použitému k ověření instančního objektu řetězec
clientCertificateSendChain Určuje, jestli se má při získávání tokenu zahrnout hlavička x5c do deklarací identity klienta, aby se povolilo ověřování na základě názvu subjektu nebo vystavitele pro klientský certifikát. bool
clientId ID klienta pro ověřování instančního objektu. řetězec
clientSecret Tajný klíč klienta pro ověřování instančního objektu řetězec
id tenanta ID tenanta pro ověřování instančního objektu řetězec

BucketDefinition

Název Description Hodnota
Accesskey Přístupový klíč ve formátu prostého textu používaný k bezpečnému přístupu k kbelíku S3 řetězec
bucketName Název kontejneru, který se má synchronizovat z koncového bodu adresy URL pro konfiguraci toku. řetězec
Nejistá Určete, jestli se má používat nezabezpečená komunikace při pučení dat z kbelíku S3. bool
localAuthRef Název místního tajného klíče v clusteru Kubernetes, který se použije jako ověřovací tajný klíč místo spravovaných nebo uživatelem poskytnutých konfiguračních tajných kódů. řetězec
syncIntervalInSeconds Interval, ve kterém se má zdroj kontejneru clusteru znovu sloučit se vzdáleným. int
timeoutInSeconds Maximální doba pokusu o odsouhlasení zdroje kontejneru clusteru se vzdáleným. int
url Adresa URL pro synchronizaci kontejneru S3 konfigurace flux. řetězec

GitRepositoryDefinition

Název Description Hodnota
httpsCACert Obsah certifikační autority HTTPS s kódováním Base64, který slouží k přístupu k privátním úložištím Git přes HTTPS řetězec
httpsUser Uživatelské jméno HTTPS ve formátu prostého textu, které se používá pro přístup k privátním úložištím Git přes HTTPS řetězec
localAuthRef Název místního tajného klíče v clusteru Kubernetes, který se použije jako ověřovací tajný klíč místo spravovaných nebo uživatelem poskytnutých konfiguračních tajných kódů. řetězec
repositoryRef Referenční informace ke zdroji objektu GitRepository RepositoryRefDefinition
sshKnownHosts Hodnota known_hosts kódování Base64 obsahující veřejné klíče SSH vyžadované pro přístup k privátním úložištím Git přes SSH řetězec
syncIntervalInSeconds Interval, ve kterém se má znovu sloučit zdroj úložiště Git clusteru se vzdáleným úložištěm. int
timeoutInSeconds Maximální doba pokusu o odsouhlasení zdroje úložiště Git clusteru se vzdáleným úložištěm int
url Adresa URL, která se má synchronizovat pro úložiště Git konfigurace flux. řetězec

RepositoryRefDefinition

Název Description Hodnota
branch Název větve úložiště Git, který chcete rezervovat. řetězec
Spáchat Potvrzení sha k rezervaci Tato hodnota musí být kombinována s názvem větve, aby byla platná. To má přednost před semver. řetězec
semver Rozsah semveru použitý ke shodě se značkami úložiště Git. To má přednost před značkou. řetězec
značka Název značky úložiště Git, který chcete rezervovat. To má přednost před větví. řetězec