Compartilhar via

Microsoft.KubernetesConfiguration fluxConfigurations 2022-03-01

Definição de recurso do Bicep

O tipo de recurso fluxConfigurations pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.KubernetesConfiguration/fluxConfigurations, adicione o Bicep a seguir ao modelo.

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
  }
}

Valores da propriedade

Microsoft.KubernetesConfiguration/fluxConfigurations

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades para criar um recurso de Configuração do Flux FluxConfigurationProperties
âmbito Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .

Definição de bucket

Nome Descrição Valor
chave de acesso Chave de acesso de texto sem formatação usada para acessar com segurança o bucket S3 corda
nome do balde O nome do bucket a ser sincronizado do ponto de extremidade da URL para a configuração do fluxo. corda
inseguro Especifique se deve usar a comunicação insegura ao pulverizar dados do bucket S3. Bool
localAuthRef Nome de um segredo local no cluster do Kubernetes a ser usado como o segredo de autenticação em vez dos segredos de configuração gerenciados ou fornecidos pelo usuário. corda
syncIntervalInSeconds O intervalo no qual reconciliar novamente a origem do repositório git do cluster com o remoto. int
timeoutInSeconds O tempo máximo para tentar reconciliar a origem do repositório git do cluster com o remoto. int
URL A URL a ser sincronizada para o bucket S3 de configuração de fluxo. corda

FluxConfigurationProperties

Nome Descrição Valor
balde Parâmetros para reconciliar com o tipo de origem bucket. bucketDefinition
configuraçãoProtegidaConfigurações Pares chave-valor das configurações protegidas para a configuração FluxConfigurationPropertiesConfigurationProtectedSettings
gitRepository Parâmetros para reconciliar com o tipo de origem gitRepository. GitRepositoryDefinition
kustomizações Matriz de kustomizations usadas para reconciliar o artefato extraído pelo tipo de origem no cluster. FluxConfigurationPropertiesKustomizations
Namespace O namespace no qual essa configuração está instalada. Máximo de 253 caracteres alfanuméricos de minúsculas, hífen e ponto somente. corda
âmbito Escopo no qual o operador será instalado. 'Cluster'
'namespace'
tipo de fonte Tipo de origem do qual extrair os dados de configuração. 'Balde'
'GitRepository'
suspender Se essa configuração deve suspender sua reconciliação de suas kustomizations e fontes. Bool

FluxConfigurationPropertiesConfigurationProtectedSettings

Nome Descrição Valor

FluxConfigurationPropertiesKustomizations

Nome Descrição Valor

Definição do repositório do Git

Nome Descrição Valor
httpsCACert Conteúdo da autoridade de certificação HTTPS codificada em Base64 usado para acessar repositórios git privados git via HTTPS corda
httpsUsuário Nome de usuário HTTPS de texto sem formatação usado para acessar repositórios git privados por HTTPS corda
localAuthRef Nome de um segredo local no cluster do Kubernetes a ser usado como o segredo de autenticação em vez dos segredos de configuração gerenciados ou fornecidos pelo usuário. corda
repositórioRef A referência de origem para o objeto GitRepository. RepositoryRefDefinition
sshKnownHosts Valor de known_hosts codificado em Base64 que contém chaves SSH públicas necessárias para acessar repositórios git privados por SSH corda
syncIntervalInSeconds O intervalo no qual reconciliar novamente a origem do repositório git do cluster com o remoto. int
timeoutInSeconds O tempo máximo para tentar reconciliar a origem do repositório git do cluster com o remoto. int
URL A URL a ser sincronizada para o repositório git de configuração de fluxo. corda

KustomizationDefinição

Nome Descrição Valor
depende Especifica outras Kustomizations das quais essa Kustomization depende. Essa Kustomization não se reconciliará até que todas as dependências tenham concluído a reconciliação. cadeia de caracteres[]
força Habilite/desabilite a recriação de recursos do Kubernetes no cluster quando a aplicação de patch falhar devido a uma alteração de campo imutável. Bool
caminho O caminho na referência de origem a ser reconciliado no cluster. corda
ameixa seca Habilitar/desabilitar coletas de lixo de objetos kubernetes criados por essa Kustomization. Bool
retryIntervalInSeconds O intervalo no qual reconciliar novamente a Kustomization no cluster em caso de falha na reconciliação. int
syncIntervalInSeconds O intervalo no qual reconciliar novamente a Kustomization no cluster. int
timeoutInSeconds O tempo máximo para tentar reconciliar a Kustomization no cluster. int

RepositoryRefDefinition

Nome Descrição Valor
ramo O nome do branch do repositório git para check-out. corda
cometer O SHA de confirmação para o check-out. Esse valor deve ser combinado com o nome do branch para ser válido. Isso tem precedência sobre semver. corda
semver O intervalo semver usado para corresponder às marcas do repositório git. Isso tem precedência sobre a marca. corda
etiqueta O nome da marca do repositório git para check-out. Isso tem precedência sobre o branch. corda

Exemplos de uso

Módulos verificados do Azure

O módulos verificados do Azure a seguir pode ser usado para implantar esse tipo de recurso.

Módulo Descrição
de configuração de fluxo de configuração do Kubernetes Módulo de recurso AVM para configuração do Flux de configuração do Kubernetes

Definição de recurso de modelo do ARM

O tipo de recurso fluxConfigurations pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.KubernetesConfiguration/fluxConfigurations, adicione o JSON a seguir ao modelo.

{
  "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"
  }
}

Valores da propriedade

Microsoft.KubernetesConfiguration/fluxConfigurations

Nome Descrição Valor
apiVersion A versão da API '2022-03-01'
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades para criar um recurso de Configuração do Flux FluxConfigurationProperties
tipo O tipo de recurso 'Microsoft.KubernetesConfiguration/fluxConfigurations'

Definição de bucket

Nome Descrição Valor
chave de acesso Chave de acesso de texto sem formatação usada para acessar com segurança o bucket S3 corda
nome do balde O nome do bucket a ser sincronizado do ponto de extremidade da URL para a configuração do fluxo. corda
inseguro Especifique se deve usar a comunicação insegura ao pulverizar dados do bucket S3. Bool
localAuthRef Nome de um segredo local no cluster do Kubernetes a ser usado como o segredo de autenticação em vez dos segredos de configuração gerenciados ou fornecidos pelo usuário. corda
syncIntervalInSeconds O intervalo no qual reconciliar novamente a origem do repositório git do cluster com o remoto. int
timeoutInSeconds O tempo máximo para tentar reconciliar a origem do repositório git do cluster com o remoto. int
URL A URL a ser sincronizada para o bucket S3 de configuração de fluxo. corda

FluxConfigurationProperties

Nome Descrição Valor
balde Parâmetros para reconciliar com o tipo de origem bucket. bucketDefinition
configuraçãoProtegidaConfigurações Pares chave-valor das configurações protegidas para a configuração FluxConfigurationPropertiesConfigurationProtectedSettings
gitRepository Parâmetros para reconciliar com o tipo de origem gitRepository. GitRepositoryDefinition
kustomizações Matriz de kustomizations usadas para reconciliar o artefato extraído pelo tipo de origem no cluster. FluxConfigurationPropertiesKustomizations
Namespace O namespace no qual essa configuração está instalada. Máximo de 253 caracteres alfanuméricos de minúsculas, hífen e ponto somente. corda
âmbito Escopo no qual o operador será instalado. 'Cluster'
'namespace'
tipo de fonte Tipo de origem do qual extrair os dados de configuração. 'Balde'
'GitRepository'
suspender Se essa configuração deve suspender sua reconciliação de suas kustomizations e fontes. Bool

FluxConfigurationPropertiesConfigurationProtectedSettings

Nome Descrição Valor

FluxConfigurationPropertiesKustomizations

Nome Descrição Valor

Definição do repositório do Git

Nome Descrição Valor
httpsCACert Conteúdo da autoridade de certificação HTTPS codificada em Base64 usado para acessar repositórios git privados git via HTTPS corda
httpsUsuário Nome de usuário HTTPS de texto sem formatação usado para acessar repositórios git privados por HTTPS corda
localAuthRef Nome de um segredo local no cluster do Kubernetes a ser usado como o segredo de autenticação em vez dos segredos de configuração gerenciados ou fornecidos pelo usuário. corda
repositórioRef A referência de origem para o objeto GitRepository. RepositoryRefDefinition
sshKnownHosts Valor de known_hosts codificado em Base64 que contém chaves SSH públicas necessárias para acessar repositórios git privados por SSH corda
syncIntervalInSeconds O intervalo no qual reconciliar novamente a origem do repositório git do cluster com o remoto. int
timeoutInSeconds O tempo máximo para tentar reconciliar a origem do repositório git do cluster com o remoto. int
URL A URL a ser sincronizada para o repositório git de configuração de fluxo. corda

KustomizationDefinição

Nome Descrição Valor
depende Especifica outras Kustomizations das quais essa Kustomization depende. Essa Kustomization não se reconciliará até que todas as dependências tenham concluído a reconciliação. cadeia de caracteres[]
força Habilite/desabilite a recriação de recursos do Kubernetes no cluster quando a aplicação de patch falhar devido a uma alteração de campo imutável. Bool
caminho O caminho na referência de origem a ser reconciliado no cluster. corda
ameixa seca Habilitar/desabilitar coletas de lixo de objetos kubernetes criados por essa Kustomization. Bool
retryIntervalInSeconds O intervalo no qual reconciliar novamente a Kustomization no cluster em caso de falha na reconciliação. int
syncIntervalInSeconds O intervalo no qual reconciliar novamente a Kustomization no cluster. int
timeoutInSeconds O tempo máximo para tentar reconciliar a Kustomization no cluster. int

RepositoryRefDefinition

Nome Descrição Valor
ramo O nome do branch do repositório git para check-out. corda
cometer O SHA de confirmação para o check-out. Esse valor deve ser combinado com o nome do branch para ser válido. Isso tem precedência sobre semver. corda
semver O intervalo semver usado para corresponder às marcas do repositório git. Isso tem precedência sobre a marca. corda
etiqueta O nome da marca do repositório git para check-out. Isso tem precedência sobre o branch. corda

Exemplos de uso

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso fluxConfigurations pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.KubernetesConfiguration/fluxConfigurations, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KubernetesConfiguration/fluxConfigurations@2022-03-01"
  name = "string"
  parent_id = "string"
  body = {
    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
    }
  }
}

Valores da propriedade

Microsoft.KubernetesConfiguration/fluxConfigurations

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. cadeia de caracteres (obrigatório)
Propriedades Propriedades para criar um recurso de Configuração do Flux FluxConfigurationProperties
tipo O tipo de recurso "Microsoft.KubernetesConfiguration/fluxConfigurations@2022-03-01"

Definição de bucket

Nome Descrição Valor
chave de acesso Chave de acesso de texto sem formatação usada para acessar com segurança o bucket S3 corda
nome do balde O nome do bucket a ser sincronizado do ponto de extremidade da URL para a configuração do fluxo. corda
inseguro Especifique se deve usar a comunicação insegura ao pulverizar dados do bucket S3. Bool
localAuthRef Nome de um segredo local no cluster do Kubernetes a ser usado como o segredo de autenticação em vez dos segredos de configuração gerenciados ou fornecidos pelo usuário. corda
syncIntervalInSeconds O intervalo no qual reconciliar novamente a origem do repositório git do cluster com o remoto. int
timeoutInSeconds O tempo máximo para tentar reconciliar a origem do repositório git do cluster com o remoto. int
URL A URL a ser sincronizada para o bucket S3 de configuração de fluxo. corda

FluxConfigurationProperties

Nome Descrição Valor
balde Parâmetros para reconciliar com o tipo de origem bucket. bucketDefinition
configuraçãoProtegidaConfigurações Pares chave-valor das configurações protegidas para a configuração FluxConfigurationPropertiesConfigurationProtectedSettings
gitRepository Parâmetros para reconciliar com o tipo de origem gitRepository. GitRepositoryDefinition
kustomizações Matriz de kustomizations usadas para reconciliar o artefato extraído pelo tipo de origem no cluster. FluxConfigurationPropertiesKustomizations
Namespace O namespace no qual essa configuração está instalada. Máximo de 253 caracteres alfanuméricos de minúsculas, hífen e ponto somente. corda
âmbito Escopo no qual o operador será instalado. 'Cluster'
'namespace'
tipo de fonte Tipo de origem do qual extrair os dados de configuração. 'Balde'
'GitRepository'
suspender Se essa configuração deve suspender sua reconciliação de suas kustomizations e fontes. Bool

FluxConfigurationPropertiesConfigurationProtectedSettings

Nome Descrição Valor

FluxConfigurationPropertiesKustomizations

Nome Descrição Valor

Definição do repositório do Git

Nome Descrição Valor
httpsCACert Conteúdo da autoridade de certificação HTTPS codificada em Base64 usado para acessar repositórios git privados git via HTTPS corda
httpsUsuário Nome de usuário HTTPS de texto sem formatação usado para acessar repositórios git privados por HTTPS corda
localAuthRef Nome de um segredo local no cluster do Kubernetes a ser usado como o segredo de autenticação em vez dos segredos de configuração gerenciados ou fornecidos pelo usuário. corda
repositórioRef A referência de origem para o objeto GitRepository. RepositoryRefDefinition
sshKnownHosts Valor de known_hosts codificado em Base64 que contém chaves SSH públicas necessárias para acessar repositórios git privados por SSH corda
syncIntervalInSeconds O intervalo no qual reconciliar novamente a origem do repositório git do cluster com o remoto. int
timeoutInSeconds O tempo máximo para tentar reconciliar a origem do repositório git do cluster com o remoto. int
URL A URL a ser sincronizada para o repositório git de configuração de fluxo. corda

KustomizationDefinição

Nome Descrição Valor
depende Especifica outras Kustomizations das quais essa Kustomization depende. Essa Kustomization não se reconciliará até que todas as dependências tenham concluído a reconciliação. cadeia de caracteres[]
força Habilite/desabilite a recriação de recursos do Kubernetes no cluster quando a aplicação de patch falhar devido a uma alteração de campo imutável. Bool
caminho O caminho na referência de origem a ser reconciliado no cluster. corda
ameixa seca Habilitar/desabilitar coletas de lixo de objetos kubernetes criados por essa Kustomization. Bool
retryIntervalInSeconds O intervalo no qual reconciliar novamente a Kustomization no cluster em caso de falha na reconciliação. int
syncIntervalInSeconds O intervalo no qual reconciliar novamente a Kustomization no cluster. int
timeoutInSeconds O tempo máximo para tentar reconciliar a Kustomization no cluster. int

RepositoryRefDefinition

Nome Descrição Valor
ramo O nome do branch do repositório git para check-out. corda
cometer O SHA de confirmação para o check-out. Esse valor deve ser combinado com o nome do branch para ser válido. Isso tem precedência sobre semver. corda
semver O intervalo semver usado para corresponder às marcas do repositório git. Isso tem precedência sobre a marca. corda
etiqueta O nome da marca do repositório git para check-out. Isso tem precedência sobre o branch. corda