OperatingSystemManager CRDs Reference
Packages
operatingsystemmanager.k8c.io/v1alpha1
Package v1alpha1 defines the v1alpha1 version of the OSM API
CloudInitModule
CloudInitModule contains the fields of the cloud init module.
Appears in:
Field | Description |
---|
bootcmd string array | BootCMD module runs arbitrary commands very early in the boot process, only slightly after a boothook would run. |
rh_subscription object (keys:string, values:string) | RHSubscription registers a Red Hat system either by username and password or activation and org |
runcmd string array | RunCMD Run arbitrary commands at a rc.local like level with output to the console. |
yum_repos object (keys:string, values:object) | YumRepos adds yum repository configuration to the system. |
yum_repo_dir string | YumRepoDir the repo parts directory where individual yum repo config files will be written. Default: /etc/yum.repos.d |
Back to top
CloudProviderSpec
CloudProviderSpec contains the os/image reference for a specific supported cloud provider
Appears in:
Field | Description |
---|
name CloudProvider | Name represents the name of the supported cloud provider |
spec RawExtension | Spec represents the os/image reference in the supported cloud provider |
Back to top
ContainerRuntimeSpec
ContainerRuntimeSpec aggregates information about a specific container runtime
Appears in:
Field | Description |
---|
name ContainerRuntime | Name of the Container runtime |
files File array | Files to add to the main files list when the containerRuntime is selected |
templates object (keys:string, values:string) | Templates to add to the available templates when the containerRuntime is selected |
Back to top
DropIn
DropIn is a drop-in configuration for a systemd unit.
Appears in:
Field | Description |
---|
name string | Name is the name of the drop-in. |
content string | Content is the content of the drop-in. |
Back to top
File
File is a file that should get written to the host’s file system. The content can either be inlined or referenced from a secret in the same namespace.
Appears in:
Field | Description |
---|
path string | Path is the path of the file system where the file should get written to. |
permissions integer | Permissions describes with which permissions the file should get written to the file system. Should be in decimal base and without any leading zeroes. |
content FileContent | Content describe the file’s content. |
Back to top
FileContent
FileContent can either reference a secret or contain inline configuration.
Appears in:
Field | Description |
---|
inline FileContentInline | Inline is a struct that contains information about the inlined data. |
Back to top
FileContentInline
FileContentInline contains keys for inlining a file content’s data and encoding.
Appears in:
Field | Description |
---|
encoding string | Encoding is the file’s encoding (e.g. base64). |
data string | Data is the file’s data. |
Back to top
OSCConfig
Appears in:
Field | Description |
---|
units Unit array | Units a list of the systemd unit files which will run on the instance |
files File array | Files is a list of files that should exist in the instance |
userSSHKeys string array | UserSSHKeys is a list of attached user ssh keys |
modules CloudInitModule | CloudInitModules contains the supported cloud-init modules |
Back to top
OSPConfig
Appears in:
Field | Description |
---|
supportedContainerRuntimes ContainerRuntimeSpec array | SupportedContainerRuntimes represents the container runtimes supported by the given OS. Docker has been deprecated and is no-op. |
templates object (keys:string, values:string) | Templates to be included in units and files |
units Unit array | Units a list of the systemd unit files which will run on the instance |
files File array | Files is a list of files that should exist in the instance |
modules CloudInitModule | CloudInitModules field contains the optional cloud-init modules which are supported by OSM |
Back to top
OperatingSystemConfig
OperatingSystemConfig is the object that represents the OperatingSystemConfig
Appears in:
Field | Description |
---|
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec OperatingSystemConfigSpec | OperatingSystemConfigSpec represents the operating system configuration spec. |
Back to top
OperatingSystemConfigSpec
OperatingSystemConfigSpec represents the data in the newly created OperatingSystemConfig
Appears in:
Field | Description |
---|
osName OperatingSystem | OSType represent the operating system name e.g: ubuntu |
osVersion string | OSVersion the version of the operating system |
cloudProvider CloudProviderSpec | CloudProvider represent the cloud provider that support the given operating system version |
bootstrapConfig OSCConfig | BootstrapConfig is used for initial configuration of machine and to fetch the kubernetes secret that contains the provisioning config. |
provisioningConfig OSCConfig | ProvisioningConfig is used for provisioning the worker node. |
provisioningUtility ProvisioningUtility | ProvisioningUtility used for configuring the worker node. Defaults to cloud-init. |
Back to top
OperatingSystemProfile
OperatingSystemProfile is the object that represents the OperatingSystemProfile
Appears in:
Field | Description |
---|
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec OperatingSystemProfileSpec | OperatingSystemProfileSpec represents the operating system configuration spec. |
Back to top
OperatingSystemProfileSpec
OperatingSystemProfileSpec represents the data in the newly created OperatingSystemProfile
Appears in:
Field | Description |
---|
osName OperatingSystem | OSType represent the operating system name e.g: ubuntu |
osVersion string | OSVersion the version of the operating system |
version string | Version is the version of the operating System Profile |
supportedCloudProviders CloudProviderSpec array | SupportedCloudProviders represent the cloud providers that support the given operating system version |
bootstrapConfig OSPConfig | BootstrapConfig is used for initial configuration of machine and to fetch the kubernetes secret that contains the provisioning config. |
provisioningConfig OSPConfig | ProvisioningConfig is used for provisioning the worker node. |
provisioningUtility ProvisioningUtility | ProvisioningUtility used for configuring the worker node. Defaults to cloud-init. |
Back to top
Unit
Unit is a systemd unit used for the operating system config.
Appears in:
Field | Description |
---|
name string | Name is the name of a unit. |
enable boolean | Enable describes whether the unit is enabled or not. |
mask boolean | Mask describes whether the unit is masked or not. |
content string | Content is the unit’s content. |
dropIns DropIn array | DropIns is a list of drop-ins for this unit. |
Back to top