Anvil-provision-server: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
Line 28: | Line 28: | ||
; '''--ci-test''' <new name> | ; '''--ci-test''' <new name> | ||
: This switch is not meant to be used outside of automated testing. It reports the resources available to create a new server for a given '''--anvil'''. Use with '''--machine''' to display the information in a machine-parsable format. | : This switch is not meant to be used outside of automated testing. It reports the resources available to create a new server for a given '''--anvil'''. Use with '''--machine''' to display the information in a machine-parsable format. | ||
; '''--driver-disc''' <ISO name> | |||
: This tells the system to create to new server with a second optical disc with the specified ISO mounted as a driver disc. This ISO will NOT be the one used to boot the new server. | : This tells the system to create to new server with a second optical disc with the specified ISO mounted as a driver disc. This ISO will NOT be the one used to boot the new server. | ||
; '''--cpu''' <cores> | ; '''--cpu''' <cores> | ||
Line 53: | Line 53: | ||
: This tells the program how big to create the hard drive for the new server. It can be specified in bytes, or in a human-readable format (without spaces). For example, '--storage-size 100GiB' would allocate 100 gibibytes to the server. In the unlikely case that you want to specify a base-10 value, '--100GB' would allocate 100 billion bytes even (or about 93.13 GiB). | : This tells the program how big to create the hard drive for the new server. It can be specified in bytes, or in a human-readable format (without spaces). For example, '--storage-size 100GiB' would allocate 100 gibibytes to the server. In the unlikely case that you want to specify a base-10 value, '--100GB' would allocate 100 billion bytes even (or about 93.13 GiB). | ||
: '''Note''' | : '''Note''' | ||
: The replicated storage metadata will be at the end of this disk. The practical effect of this is that the disk size presented to the new server will be ~ 32 MiB per 1 TiB less than what you are requesting. If you are planning to copy an image from an existing server, it is recommended to allocate an additional 1 GiB to be sure that the image will fit. | : The replicated storage metadata will be at the end of this disk. The practical effect of this is that the disk size presented to the new server will be ~ 32 MiB per 1 TiB less than what you are requesting. If you are planning to copy an image from an existing server, it is recommended to allocate an additional 1 GiB to be sure that the image will fit. | ||
= AUTHOR = | = AUTHOR = |
Latest revision as of 15:32, 1 October 2024
Alteeve Wiki :: Man Pages :: Anvil-provision-server |
NAME
anvil-provision-server - Tool to provision new servers.
SYNOPSIS
anvil-provision-server <command> [options]
DESCRIPTION
This tool is used to provision (create) new servers on an Anvil! IA cluster. It can be run interactively, or using switches.
OPTIONS
- -?, -h, --help
- Show this man page.
- --log-secure
- When logging, record sensitive data, like passwords.
- -v, -vv, -vvv
- Set the log level to 1, 2 or 3 respectively. Be aware that level 3 generates a significant amount of log data.
Commands:
- --anvil, --anvil-name, --anvil-uuid <anvil name or uuid>
- This is the Anvil! name or UUID that the new server will be provisioned on.
- --ci-test <new name>
- This switch is not meant to be used outside of automated testing. It reports the resources available to create a new server for a given --anvil. Use with --machine to display the information in a machine-parsable format.
- --driver-disc <ISO name>
- This tells the system to create to new server with a second optical disc with the specified ISO mounted as a driver disc. This ISO will NOT be the one used to boot the new server.
- --cpu <cores>
- This is the number of CPU cores to allocate to the new server. This will be created as a single socket CPU with the requested number of cores.
- --install-media <ISO name>
- This selects the ISO to boot off of. It is generally the OS installation disc for your selected operating system.
- --machine <ISO name>
- This tells the program to display information in a machine-parsable format.
- --name <name>
- This is the name to give to the new server. The limitations on the name are the same as the limitation imposed by 'virt-install'. The name must be globally unique across the Anvil! IA cluster. It is recommended to keep the name under 16 characters long.
- --network <string; bridge=<bridge_name>[,mac=<mac_address>],model=<virt-install NIC model>]]>
- This is a string that controls how the network is configured. The 'bridge=<bridge_name>' is required, and determines which bridge (virtual ethernet switch) the interface will be "plugged into". Optionally, you can add ',mac=<mac_address>' to specify the MAC address that the new network interface will be given. This is useful when migrating a server from another host. Last, you can optionally use ',model=<NIC model>' to control what hardware is used to emulate the new network card. Generally this is 'virtio', but could also be 'e1000e' to emulate an Intel network card, or 'rtl8139' to emulate a basic Realtek network card.
- --options
- This tells the program to report valid options that can be used, including the valid range of CPU cores, RAM, available ISOs, etc.
- --os <short id>
- This controls how the hypervisor will optimize the new server for a given operating system. The list of valid options are long, and can be seen by running 'osinfo-query os'. Use the name under the 'Short ID' column that is the closest match to the OS you plan to install.
- --uuid <UUID>
- Normally, a new UUID is created for the new server. If you want to specify a specific UUID, typically when migrating a server from another host, you can do so with this switch.
- --ram <human readable size>
- This tells the program how much RAM to allocate to the new server. It can be specified in bytes, or in a human-readable format (without spaces). For example, '--ram 8GiB' would allocate 8 gibibytes to the server. In the unlikely case that you want to specify a base-10 value, '--8GB' would allocate 8 billion bytes even (or about 7.45 GiB).
- --storage-group <name or UUID>
- This is the storage group (by name or UUID) to use when creating the new hard drive for the server.
- --storage-size <human readable size>
- This tells the program how big to create the hard drive for the new server. It can be specified in bytes, or in a human-readable format (without spaces). For example, '--storage-size 100GiB' would allocate 100 gibibytes to the server. In the unlikely case that you want to specify a base-10 value, '--100GB' would allocate 100 billion bytes even (or about 93.13 GiB).
- Note
- The replicated storage metadata will be at the end of this disk. The practical effect of this is that the disk size presented to the new server will be ~ 32 MiB per 1 TiB less than what you are requesting. If you are planning to copy an image from an existing server, it is recommended to allocate an additional 1 GiB to be sure that the image will fit.
AUTHOR
Written by Madison Kelly, Alteeve staff and the Anvil! project contributors.
REPORTING BUGS
Report bugs to users@clusterlabs.org
Any questions, feedback, advice, complaints or meanderings are welcome. | |||
Alteeve's Niche! | Alteeve Enterprise Support | Community Support | |
© 2025 Alteeve. Intelligent Availability® is a registered trademark of Alteeve's Niche! Inc. 1997-2025 | |||
legal stuff: All info is provided "As-Is". Do not use anything here unless you are willing and able to take responsibility for your own actions. |