const (
    // DataSecretAvailableCondition documents the status of the bootstrap secret generation process.
    //
    // NOTE: When the DataSecret generation starts the process completes immediately and within the
    // same reconciliation, so the user will always see a transition from Wait to Generated without having
    // evidence that BootstrapSecret generation is started/in progress.
    DataSecretAvailableCondition clusterv1.ConditionType = "DataSecretAvailable"

    // WaitingForClusterInfrastructureReason (Severity=Info) document a bootstrap secret generation process
    // waiting for the cluster infrastructure to be ready.
    //
    // NOTE: Having the cluster infrastructure ready is a pre-condition for starting to create machines;
    // the KubeadmConfig controller ensure this pre-condition is satisfied.
    WaitingForClusterInfrastructureReason = "WaitingForClusterInfrastructure"

    // WaitingForControlPlaneAvailableReason (Severity=Info) document a bootstrap secret generation process
    // waiting for the control plane machine to be available.
    //
    // NOTE: Having the control plane machine available is a pre-condition for joining additional control planes
    // or workers nodes.
    WaitingForControlPlaneAvailableReason = "WaitingForControlPlaneAvailable"

    // DataSecretGenerationFailedReason (Severity=Warning) documents a KubeadmConfig controller detecting
    // an error while generating a data secret; those kind of errors are usually due to misconfigurations
    // and user intervention is required to get them fixed.
    DataSecretGenerationFailedReason = "DataSecretGenerationFailed"
)

const (
    // CertificatesAvailableCondition documents that cluster certificates are available.
    //
    // NOTE: Cluster certificates are generated only for the KubeadmConfig object linked to the initial control plane
    // machine, if the cluster is not using a control plane ref object, if the certificates are not provided
    // by the users.
    // IMPORTANT: This condition won't be re-created after clusterctl move.
    CertificatesAvailableCondition clusterv1.ConditionType = "CertificatesAvailable"

    // CertificatesGenerationFailedReason (Severity=Warning) documents a KubeadmConfig controller detecting
    // an error while generating certificates; those kind of errors are usually temporary and the controller
    // automatically recover from them.
    CertificatesGenerationFailedReason = "CertificatesGenerationFailed"

    // CertificatesCorruptedReason (Severity=Error) documents a KubeadmConfig controller detecting
    // an error while while retrieving certificates for a joining node.
    CertificatesCorruptedReason = "CertificatesCorrupted"
)

var (
    // GroupVersion is group version used to register these objects
    GroupVersion = schema.GroupVersion{Group: "bootstrap.cluster.x-k8s.io", Version: "v1alpha3"}

    // SchemeBuilder is used to add go types to the GroupVersionKind scheme
    SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

    // AddToScheme adds the types in this group-version to the given scheme.
    AddToScheme = SchemeBuilder.AddToScheme
)

var (
    ConflictingFileSourceMsg = "only one of content of contentFrom may be specified for a single file"
    MissingFileSourceMsg     = "source for file content must be specified if contenFrom is non-nil"
    MissingSecretNameMsg     = "secret file source must specify non-empty secret name"
    MissingSecretKeyMsg      = "secret file source must specify non-empty secret key"
    PathConflictMsg          = "path property must be unique among all files"
)

type DiskSetup struct {
    // Partitions specifies the list of the partitions to setup.
    Partitions []Partition `json:"partitions,omitempty"`
    // Filesystems specifies the list of file systems to setup.
    Filesystems []Filesystem `json:"filesystems,omitempty"`
}

type Encoding string

const (
    // Base64 implies the contents of the file are encoded as base64.
    Base64 Encoding = "base64"
    // Gzip implies the contents of the file are encoded with gzip.
    Gzip Encoding = "gzip"
    // GzipBase64 implies the contents of the file are first base64 encoded and then gzip encoded.
    GzipBase64 Encoding = "gzip+base64"
)

type File struct {
    // Path specifies the full path on disk where to store the file.
    Path string `json:"path"`

    // Owner specifies the ownership of the file, e.g. "root:root".
    // +optional
    Owner string `json:"owner,omitempty"`

    // Permissions specifies the permissions to assign to the file, e.g. "0640".
    // +optional
    Permissions string `json:"permissions,omitempty"`

    // Encoding specifies the encoding of the file contents.
    // +optional
    Encoding Encoding `json:"encoding,omitempty"`

    // Content is the actual content of the file.
    // +optional
    Content string `json:"content,omitempty"`

    // ContentFrom is a referenced source of content to populate the file.
    // +optional
    ContentFrom *FileSource `json:"contentFrom,omitempty"`
}

type FileSource struct {
    // Secret represents a secret that should populate this file.
    Secret SecretFileSource `json:"secret"`
}

type Filesystem struct {
    // Device specifies the device name
    Device string `json:"device"`
    // Filesystem specifies the file system type.
    Filesystem string `json:"filesystem"`
    // Label specifies the file system label to be used. If set to None, no label is used.
    Label string `json:"label"`
    // Partition specifies the partition to use. The valid options are: "auto|any", "auto", "any", "none", and <NUM>, where NUM is the actual partition number.
    // +optional
    Partition *string `json:"partition,omitempty"`
    // Overwrite defines whether or not to overwrite any existing filesystem.
    // If true, any pre-existing file system will be destroyed. Use with Caution.
    // +optional
    Overwrite *bool `json:"overwrite,omitempty"`
    // ReplaceFS is a special directive, used for Microsoft Azure that instructs cloud-init to replace a file system of <FS_TYPE>.
    // NOTE: unless you define a label, this requires the use of the 'any' partition directive.
    // +optional
    ReplaceFS *string `json:"replaceFS,omitempty"`
    // ExtraOpts defined extra options to add to the command for creating the file system.
    // +optional
    ExtraOpts []string `json:"extraOpts,omitempty"`
}

type Format string

const (
    // CloudConfig make the bootstrap data to be of cloud-config format
    CloudConfig Format = "cloud-config"
)

type KubeadmConfig struct {
    metav1.TypeMeta   `json:",inline"`
    metav1.ObjectMeta `json:"metadata,omitempty"`

    Spec   KubeadmConfigSpec   `json:"spec,omitempty"`
    Status KubeadmConfigStatus `json:"status,omitempty"`
}

type KubeadmConfigList struct {
    metav1.TypeMeta `json:",inline"`
    metav1.ListMeta `json:"metadata,omitempty"`
    Items           []KubeadmConfig `json:"items"`
}

type KubeadmConfigSpec struct {
    // ClusterConfiguration along with InitConfiguration are the configurations necessary for the init command
    // +optional
    ClusterConfiguration *kubeadmv1beta1.ClusterConfiguration `json:"clusterConfiguration,omitempty"`

    // InitConfiguration along with ClusterConfiguration are the configurations necessary for the init command
    // +optional
    InitConfiguration *kubeadmv1beta1.InitConfiguration `json:"initConfiguration,omitempty"`

    // JoinConfiguration is the kubeadm configuration for the join command
    // +optional
    JoinConfiguration *kubeadmv1beta1.JoinConfiguration `json:"joinConfiguration,omitempty"`

    // Files specifies extra files to be passed to user_data upon creation.
    // +optional
    Files []File `json:"files,omitempty"`

    // DiskSetup specifies options for the creation of partition tables and file systems on devices.
    // +optional
    DiskSetup *DiskSetup `json:"diskSetup,omitempty"`

    // Mounts specifies a list of mount points to be setup.
    // +optional
    Mounts []MountPoints `json:"mounts,omitempty"`

    // PreKubeadmCommands specifies extra commands to run before kubeadm runs
    // +optional
    PreKubeadmCommands []string `json:"preKubeadmCommands,omitempty"`

    // PostKubeadmCommands specifies extra commands to run after kubeadm runs
    // +optional
    PostKubeadmCommands []string `json:"postKubeadmCommands,omitempty"`

    // Users specifies extra users to add
    // +optional
    Users []User `json:"users,omitempty"`

    // NTP specifies NTP configuration
    // +optional
    NTP *NTP `json:"ntp,omitempty"`

    // Format specifies the output format of the bootstrap data
    // +optional
    Format Format `json:"format,omitempty"`

    // Verbosity is the number for the kubeadm log level verbosity.
    // It overrides the `--v` flag in kubeadm commands.
    // +optional
    Verbosity *int32 `json:"verbosity,omitempty"`

    // UseExperimentalRetryJoin replaces a basic kubeadm command with a shell
    // script with retries for joins.
    //
    // This is meant to be an experimental temporary workaround on some environments
    // where joins fail due to timing (and other issues). The long term goal is to add retries to
    // kubeadm proper and use that functionality.
    //
    // This will add about 40KB to userdata
    //
    // For more information, refer to https://github.com/kubernetes-sigs/cluster-api/pull/2763#discussion_r397306055.
    // +optional
    UseExperimentalRetryJoin bool `json:"useExperimentalRetryJoin,omitempty"`
}

type KubeadmConfigStatus struct {
    // Ready indicates the BootstrapData field is ready to be consumed
    Ready bool `json:"ready,omitempty"`

    // DataSecretName is the name of the secret that stores the bootstrap data script.
    // +optional
    DataSecretName *string `json:"dataSecretName,omitempty"`

    // BootstrapData will be a cloud-init script for now.
    //
    // Deprecated: This field has been deprecated in v1alpha3 and
    // will be removed in a future version. Switch to DataSecretName.
    //
    // +optional
    BootstrapData []byte `json:"bootstrapData,omitempty"`

    // FailureReason will be set on non-retryable errors
    // +optional
    FailureReason string `json:"failureReason,omitempty"`

    // FailureMessage will be set on non-retryable errors
    // +optional
    FailureMessage string `json:"failureMessage,omitempty"`

    // ObservedGeneration is the latest generation observed by the controller.
    // +optional
    ObservedGeneration int64 `json:"observedGeneration,omitempty"`

    // Conditions defines current service state of the KubeadmConfig.
    // +optional
    Conditions clusterv1.Conditions `json:"conditions,omitempty"`
}

type KubeadmConfigTemplate struct {
    metav1.TypeMeta   `json:",inline"`
    metav1.ObjectMeta `json:"metadata,omitempty"`

    Spec KubeadmConfigTemplateSpec `json:"spec,omitempty"`
}

type KubeadmConfigTemplateList struct {
    metav1.TypeMeta `json:",inline"`
    metav1.ListMeta `json:"metadata,omitempty"`
    Items           []KubeadmConfigTemplate `json:"items"`
}

type KubeadmConfigTemplateResource struct {
    Spec KubeadmConfigSpec `json:"spec,omitempty"`
}

type KubeadmConfigTemplateSpec struct {
    Template KubeadmConfigTemplateResource `json:"template"`
}

type MountPoints []string

type NTP struct {
    // Servers specifies which NTP servers to use
    // +optional
    Servers []string `json:"servers,omitempty"`

    // Enabled specifies whether NTP should be enabled
    // +optional
    Enabled *bool `json:"enabled,omitempty"`
}

type Partition struct {
    // Device is the name of the device.
    Device string `json:"device"`
    // Layout specifies the device layout.
    // If it is true, a single partition will be created for the entire device.
    // When layout is false, it means don't partition or ignore existing partitioning.
    Layout bool `json:"layout"`
    // Overwrite describes whether to skip checks and create the partition if a partition or filesystem is found on the device.
    // Use with caution. Default is 'false'.
    // +optional
    Overwrite *bool `json:"overwrite,omitempty"`
    // TableType specifies the tupe of partition table. The following are supported:
    // 'mbr': default and setups a MS-DOS partition table
    // 'gpt': setups a GPT partition table
    // +optional
    TableType *string `json:"tableType,omitempty"`
}

type SecretFileSource struct {
    // Name of the secret in the KubeadmBootstrapConfig's namespace to use.
    Name string `json:"name"`

    // Key is the key in the secret's data map for this value.
    Key string `json:"key"`
}

type User struct {
    // Name specifies the user name
    Name string `json:"name"`

    // Gecos specifies the gecos to use for the user
    // +optional
    Gecos *string `json:"gecos,omitempty"`

    // Groups specifies the additional groups for the user
    // +optional
    Groups *string `json:"groups,omitempty"`

    // HomeDir specifies the home directory to use for the user
    // +optional
    HomeDir *string `json:"homeDir,omitempty"`

    // Inactive specifies whether to mark the user as inactive
    // +optional
    Inactive *bool `json:"inactive,omitempty"`

    // Shell specifies the user's shell
    // +optional
    Shell *string `json:"shell,omitempty"`

    // Passwd specifies a hashed password for the user
    // +optional
    Passwd *string `json:"passwd,omitempty"`

    // PrimaryGroup specifies the primary group for the user
    // +optional
    PrimaryGroup *string `json:"primaryGroup,omitempty"`

    // LockPassword specifies if password login should be disabled
    // +optional
    LockPassword *bool `json:"lockPassword,omitempty"`

    // Sudo specifies a sudo role for the user
    // +optional
    Sudo *string `json:"sudo,omitempty"`

    // SSHAuthorizedKeys specifies a list of ssh authorized keys for the user
    // +optional
    SSHAuthorizedKeys []string `json:"sshAuthorizedKeys,omitempty"`
}