Package version:

Interface FluxConfiguration

The Flux Configuration object returned in Get & Put response.

interface FluxConfiguration {
    azureBlob?: AzureBlobDefinition;
    bucket?: BucketDefinition;
    complianceState?: string;
    configurationProtectedSettings?: {
        [propertyName: string]: string;
    };
    errorMessage?: string;
    gitRepository?: GitRepositoryDefinition;
    id?: string;
    kustomizations?: {
        [propertyName: string]: KustomizationDefinition | null;
    };
    name?: string;
    namespace?: string;
    ociRepository?: OCIRepositoryDefinition;
    provisioningState?: string;
    reconciliationWaitDuration?: string;
    repositoryPublicKey?: string;
    scope?: string;
    sourceKind?: string;
    sourceSyncedCommitId?: string;
    sourceUpdatedAt?: any;
    statuses?: (null | ObjectStatusDefinition)[];
    statusUpdatedAt?: any;
    suspend?: boolean;
    systemData?: SystemData;
    type?: string;
    waitForReconciliation?: boolean;
}

Hierarchy (view full)

Properties

azureBlob? bucket? complianceState? configurationProtectedSettings? errorMessage? gitRepository? id? kustomizations? name? namespace? ociRepository? provisioningState? reconciliationWaitDuration? repositoryPublicKey? scope? sourceKind? sourceSyncedCommitId? sourceUpdatedAt? statuses? statusUpdatedAt? suspend? systemData? type? waitForReconciliation?

Properties

OptionalazureBlob

azureBlob?: AzureBlobDefinition

Parameters to reconcile to the AzureBlob source kind type.

Optionalbucket

bucket?: BucketDefinition

Parameters to reconcile to the Bucket source kind type.

Optional ReadonlycomplianceState

complianceState?: string

Combined status of the Flux Kubernetes resources created by the fluxConfiguration or created by the managed objects. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalconfigurationProtectedSettings

configurationProtectedSettings?: {
    [propertyName: string]: string;
}

Key-value pairs of protected configuration settings for the configuration

Optional ReadonlyerrorMessage

errorMessage?: string

Error message returned to the user in the case of provisioning failure. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalgitRepository

gitRepository?: GitRepositoryDefinition

Parameters to reconcile to the GitRepository source kind type.

Optional Readonlyid

id?: string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

Optionalkustomizations

kustomizations?: {
    [propertyName: string]: KustomizationDefinition | null;
}

Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster.

Optional Readonlyname

name?: string

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optionalnamespace

namespace?: string

The namespace to which this configuration is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only.

OptionalociRepository

ociRepository?: OCIRepositoryDefinition

Parameters to reconcile to the OCIRepository source kind type.

Optional ReadonlyprovisioningState

provisioningState?: string

Status of the creation of the fluxConfiguration. NOTE: This property will not be serialized. It can only be populated by the server.

OptionalreconciliationWaitDuration

reconciliationWaitDuration?: string

Maximum duration to wait for flux configuration reconciliation. E.g PT1H, PT5M, P1D

Optional ReadonlyrepositoryPublicKey

repositoryPublicKey?: string

Public Key associated with this fluxConfiguration (either generated within the cluster or provided by the user). NOTE: This property will not be serialized. It can only be populated by the server.

Optionalscope

scope?: string

Scope at which the operator will be installed.

OptionalsourceKind

sourceKind?: string

Source Kind to pull the configuration data from.

Optional ReadonlysourceSyncedCommitId

sourceSyncedCommitId?: string

Branch and/or SHA of the source commit synced with the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlysourceUpdatedAt

sourceUpdatedAt?: any

Datetime the fluxConfiguration synced its source on the cluster. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlystatuses

statuses?: (null | ObjectStatusDefinition)[]

Statuses of the Flux Kubernetes resources created by the fluxConfiguration or created by the managed objects provisioned by the fluxConfiguration. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlystatusUpdatedAt

statusUpdatedAt?: any

Datetime the fluxConfiguration synced its status on the cluster with Azure. NOTE: This property will not be serialized. It can only be populated by the server.

Optionalsuspend

suspend?: boolean

Whether this configuration should suspend its reconciliation of its kustomizations and sources.

Optional ReadonlysystemData

systemData?: SystemData

Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlytype

type?: string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

OptionalwaitForReconciliation

waitForReconciliation?: boolean

Whether flux configuration deployment should wait for cluster to reconcile the kustomizations.

Settings

Member Visibility