Introduction
Assumptions
- All the hardware are Uniform
- Same number of NICs with same PCI ids
- Same number of disks with same addresses.
- Everything is named and their names are used for reference - In Airship, the name if the filename is not important, but the name in the 'schema' (found in schema/metadata/name) is important.
Deployment Configuration and Strategy
| Parameter | Sub-Category-1 | Sub-Category-2 | Description | Example Value |
| physical_provisioner | ||||
| deployment_strategy | ||||
| deploy_interval | ||||
| deploy_timeout | ||||
| destroy_interval | ||||
| destroy_timeout | ||||
| join_wait | ||||
| prepare_node_interval | ||||
| prepare_node_timeout | ||||
| prepare_site_interval | ||||
| prepare_site_timeout | ||||
| verify_interval | ||||
| verify_timeout | ||||
| kubernetes | ||||
| node_status_interval | ||||
| node_status_timeout | ||||
| kubernetes_provisioner | ||||
| drain_timeout | ||||
| drain_grace_period | ||||
| clear_labels_timeout | ||||
| remove_etcd_timeout | ||||
| etcd_ready_timeout | ||||
| armada+ | ||||
| get_releases_timeout | ||||
| get_status_timeout | ||||
| manifest+ | ||||
| post_apply_timeout | ||||
| validate_design_timeout | ||||
| groups | ||||
| name | ||||
| critical | ||||
| depends_on | ||||
| selectors | ||||
| node_names | ||||
| node_labels | ||||
| node_tags | ||||
| rack_names | ||||
| success_criteria | ||||
| percent_successful_nodes | ||||
| minimum_successful_nodes | ||||
| maximum_failed_nodes |
Profiles
There are two important categories of profiles that the user should create to match their environment:
- Hardware ( site/<site_name>/profiles/hardware/<profile_name>.yaml)
- Host site/<site_name>/profiles/host/<profile_name(s)>.yaml
Hardware Profile
Under the hardware profile, user can provide details about the server, and few device (n/w and disk) aliases. User can contact the administrator to obtain this information - else, one has to obtain this information from the 'lshw' command. For example: sudo lshw -c network -businfo - to know the NIC names and PCI Ids. Once the user has the hardware information, it can be configure following parameters:
Server:
| Parameter | Description | Example-Value |
|---|---|---|
| vendor | Vendor of the server chassis | Intel |
| generation | Generation of the chassis model | '4' |
| hw_version | Version of the chassis model within its generation | '3' |
| bios_version | The certified version of the chassis BIOS | 'SE5C .... |
| boot_mode | Mode of the default boot of hardware - bios, uefi | bios |
| bootstrap_protocol | Protocol of boot of the hardware - pxe, usb, hdd | 'pxe |
| pxe_interface | Which interface to use for network booting within the OOB manager, not OS device | 0 |
Device-Aliases:
NICs:
User can categorize the NICs in the hardware as control-plane nics or dataplane nics. In each category he can have one or more NICs. For example, he can define ctrl_nic1, ctrl_nic2, ctrl_nic3, and data_nic1, data_nic2, data_nic3, etc. It is better to use names that are self-explanatory - for example, if you have a separate NIC for PXE, name it as pxe_nic. This categorization will be referred in the host-profiles. For every NIC defined, the below information can be configured.
| Parameter | Description | Example Value |
|---|---|---|
| address | The PCI address of the NIC | 0000:04:00.0 |
| dev_type | Description of the NIC | 'I350 Gigabit Network Connection' |
| bus_type | The bus supported | 'pci' |
Disks:
The Disks can be either bootdisk or datadisk(s). Similar to NICs, the self-explanatory names should be choosen. For example, cephjournal1 can be the name for one of the disks use as one the ceph journals.
For every disk defined, the below information can be configured:
| Parameter | Description | Example Value |
|---|---|---|
| address | The bus address of the Disk | 0:2.0.0 |
| dev_type | Description of the disk. | 'INTEL SSDSC2BB48' |
| bus_type | The bus supported | 'scsi' |
Others
| Parameter | Sub-category-1 | Sub-category-2 | Description | Example Value |
|---|---|---|---|---|
| cpu_set | ||||
| kvm | '4-43,48-87' | |||
| huge_pages | ||||
| dpdk | ||||
| size | '1G' | |||
| count | 32 |
Host Profiles
The host profiles Following things are covered:
- Mapping NICs of the host the Networks it would belong to. NOTE: For definition of network please refer to Networks section below.
- How the Bootdisk is partitioned.
- What all software components are enabled on the particular host.
- What hardware profile that host is using.
- Platform specific configuration for the host.
For majority of the cases, you only need two host profiles - Dataplane and Control Plane. Of course, the user can create more than 2 and use it accordingly. The below table summarizes the configurable parameters for the host profiles.
| Parameter Category | Sub-Category-1 | Sub-Category-2 | Description | Example Value 1 | Example Value 2 |
|---|---|---|---|---|---|
| hardware_profile | NA | NA | The hardware profile used by the host | intel_2600.yaml | |
| primary_network | NA | NA | The main network used for administration | dmz | |
| Interfaces | NA | NA | Define each and every interfaces of the host in detail. | ||
| Name | NA | Name of the Interface | dmz | data1 | |
| device_link | The name of the network link. | dmz | data1 | ||
| slaves | NIC Aliases | ctrl_nic1 | data_nic1 | ||
| networks | The networks this interface belongs to. | dmz | - private - management | ||
Nodes
| Parameter Category | Sub-Category-1 | Sub-Category-2 | Sub-Category-3 | Sub-Category-4 | Description | Example Value |
|---|---|---|---|---|---|---|
| addressing* | ||||||
| address | ||||||
| network | ||||||
| oob | ||||||
| network | ||||||
| account | ||||||
| credential | ||||||
| storage | ||||||
| physical_devices | ||||||
| labels | ||||||
| volume_group | ||||||
| partitions* | ||||||
| name | ||||||
| size | ||||||
| part_uuid | ||||||
| volume_group | ||||||
| labels | ||||||
| bootable | ||||||
| filesystem | ||||||
| mountpoint | ||||||
| fstype | ||||||
| mount_options | ||||||
| fs_uuid | ||||||
| fs_label | ||||||
| volume_groups | ||||||
| vg_uuid | ||||||
| logical_volumes* | ||||||
| name | ||||||
| lv_uuid | ||||||
| size | ||||||
| filesystem | ||||||
| mountpoint | ||||||
| fstype | ||||||
| mount_options | ||||||
| fs_uuid | ||||||
| fs_label | ||||||
| platform | ||||||
| image | ||||||
| kernel | ||||||
| kernel_params | ||||||
| metadata | ||||||
| tags* | ||||||
| owner_data | ||||||
| rack | ||||||
| boot_mac | ||||||
| host_profile | ||||||
| hardware_profile | ||||||
| primary_network | ||||||
| interfaces | ||||||
| device_link | ||||||
| slaves* | ||||||
| networks* |
*: Array of Values.
Network Definition
Network
| Parameter | Sub-Category | Description | Example Value |
|---|---|---|---|
| cidr | |||
| ranges* | |||
| type | |||
| start | |||
| end | |||
| dns | |||
| domain | |||
| servers | |||
| dhcp_relay | |||
| self_ip | |||
| upstream_target | |||
| mtu | |||
| vlan | |||
| routedomain | |||
| routes* | |||
| subnet | |||
| gateway | |||
| metric | |||
| routedomain | |||
| labels |
Network Link
| Parameter | Sub-Category | Description | Example Value |
|---|---|---|---|
| bonding | |||
| mode | |||
| hash | |||
| peer_rate | |||
| mon_rate | |||
| up_delay | |||
| down_delay | |||
| mtu | |||
| linkspeed | |||
| trunking | |||
| mode | |||
| default_network | |||
| allowed_networks* | |||
| labels |
Software
PKI-Catalog
Secrets
Publickeys of the Users.
Path: site/<site_name>/secrets/publickey/<username>_ssh_public_key.yaml
The public key of the user is added as 'data'.
Passphrases of the users
Path: site/<site_name>/secrets/publickey/<username>_crypt_password.yaml
Put a passphrase for the user as 'data'.
Actions
| Parameter | Sub-Category-1 | sub-category-2 | Description | Example Value |
|---|---|---|---|---|
| signaling | ||||
| assets | ||||
| items | ||||
| path | ||||
| location | ||||
| type | 'unit','file', 'pkg_list | |||
| data | ||||
| location_pipeline | template | |||
| data_pipeline | base64_encode', 'template', 'base64_decode', 'utf8_encode','utf8_decode' | |||
| permissions | ||||
| node_filter | ||||
| filter_set_type | ||||
| filter_set items | ||||
| filter_type | ||||
| node_names | ||||
| node_tags | ||||
| node_labels | ||||
| rack_names | ||||
| rack_labels |
Rack
| Parameter | Sub-Category | Description | Example Value |
|---|---|---|---|
| tor_switches | |||
| mgmt_ip | |||
| sdn_api_uri | |||
| location | |||
| clli | |||
| grid | |||
| local_networks* | |||
| labels |
Region
| Parameter | Sub-Category | Description | Example Value |
|---|---|---|---|
| tag_definitions* | |||
| tag | |||
| definition_type | lshw_xpath | ||
| definition | |||
| authorized_keys* | |||
| repositories | |||
| remove_unlisted | |||
| repo_type+ | |||
| url+ | |||
| distributions | |||
| subrepos | |||
| components | |||
| gpgkey | |||
| arches+ | |||
| options |