FluxConfiguration interface
The Flux Configuration object returned in Get & Put response.
- Extends
Properties
azure |
Parameters to reconcile to the AzureBlob source kind type. |
bucket | Parameters to reconcile to the Bucket source kind type. |
compliance |
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. |
configuration |
Key-value pairs of protected configuration settings for the configuration |
error |
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. |
git |
Parameters to reconcile to the GitRepository source kind type. |
kustomizations | Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster. |
namespace | The namespace to which this configuration is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only. |
provisioning |
Status of the creation of the fluxConfiguration. NOTE: This property will not be serialized. It can only be populated by the server. |
reconciliation |
Maximum duration to wait for flux configuration reconciliation. E.g PT1H, PT5M, P1D |
repository |
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. |
scope | Scope at which the operator will be installed. |
source |
Source Kind to pull the configuration data from. |
source |
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. |
source |
Datetime the fluxConfiguration synced its source on the cluster. NOTE: This property will not be serialized. It can only be populated by the server. |
statuses | 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. |
status |
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. |
suspend | Whether this configuration should suspend its reconciliation of its kustomizations and sources. |
system |
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. |
wait |
Whether flux configuration deployment should wait for cluster to reconcile the kustomizations. |
Inherited Properties
id | 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. |
name | The name of the resource NOTE: This property will not be serialized. It can only be populated by the server. |
type | 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. |
Property Details
azureBlob
Parameters to reconcile to the AzureBlob source kind type.
azureBlob?: AzureBlobDefinition
Property Value
bucket
Parameters to reconcile to the Bucket source kind type.
bucket?: BucketDefinition
Property Value
complianceState
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.
complianceState?: string
Property Value
string
configurationProtectedSettings
Key-value pairs of protected configuration settings for the configuration
configurationProtectedSettings?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
errorMessage
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.
errorMessage?: string
Property Value
string
gitRepository
Parameters to reconcile to the GitRepository source kind type.
gitRepository?: GitRepositoryDefinition
Property Value
kustomizations
Array of kustomizations used to reconcile the artifact pulled by the source type on the cluster.
kustomizations?: {[propertyName: string]: KustomizationDefinition | null}
Property Value
{[propertyName: string]: KustomizationDefinition | null}
namespace
The namespace to which this configuration is installed to. Maximum of 253 lower case alphanumeric characters, hyphen and period only.
namespace?: string
Property Value
string
provisioningState
Status of the creation of the fluxConfiguration. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: string
Property Value
string
reconciliationWaitDuration
Maximum duration to wait for flux configuration reconciliation. E.g PT1H, PT5M, P1D
reconciliationWaitDuration?: string
Property Value
string
repositoryPublicKey
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.
repositoryPublicKey?: string
Property Value
string
scope
Scope at which the operator will be installed.
scope?: string
Property Value
string
sourceKind
Source Kind to pull the configuration data from.
sourceKind?: string
Property Value
string
sourceSyncedCommitId
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.
sourceSyncedCommitId?: string
Property Value
string
sourceUpdatedAt
Datetime the fluxConfiguration synced its source on the cluster. NOTE: This property will not be serialized. It can only be populated by the server.
sourceUpdatedAt?: Date
Property Value
Date
statuses
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.
statuses?: (null | ObjectStatusDefinition)[]
Property Value
(null | ObjectStatusDefinition)[]
statusUpdatedAt
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.
statusUpdatedAt?: Date
Property Value
Date
suspend
Whether this configuration should suspend its reconciliation of its kustomizations and sources.
suspend?: boolean
Property Value
boolean
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.
systemData?: SystemData
Property Value
waitForReconciliation
Whether flux configuration deployment should wait for cluster to reconcile the kustomizations.
waitForReconciliation?: boolean
Property Value
boolean
Inherited Property Details
id
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.
id?: string
Property Value
string
Inherited From ProxyResource.id
name
The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From ProxyResource.name
type
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.
type?: string
Property Value
string
Inherited From ProxyResource.type