diff --git a/doc/source/index.rst b/doc/source/index.rst index 789ce518..f52bcf52 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -59,6 +59,7 @@ User Guide user/states user/root-disk-partitions + user/server-groups Administrator Guide diff --git a/doc/source/user/root-disk-partitions.rst b/doc/source/user/root-disk-partitions.rst index df317155..89e70997 100644 --- a/doc/source/user/root-disk-partitions.rst +++ b/doc/source/user/root-disk-partitions.rst @@ -11,3 +11,15 @@ the root partition until the end of the disk. .. note:: Whole disk images, on the contrary, not support partitions, passing partitions to server creation results in a fault and will prevent the creation from happening. + +#. To create server with partitions, use ``--partition`` parameter on the +:command:`openstack baremetalcompute server create` command. + + For example: + + .. code-block:: console + + $ openstack baremetalcompute server create --image IMAGE --flavor gold \ + --key-name KEY --availability-zone ZONE --partition root_gb=100 \ + --partition ephemeral_gb=200 --partition swap_mb=40960 \ + --nic net-id=UUID SERVER diff --git a/doc/source/user/server-groups.rst b/doc/source/user/server-groups.rst new file mode 100644 index 00000000..208fc569 --- /dev/null +++ b/doc/source/user/server-groups.rst @@ -0,0 +1,61 @@ +Server Groups +============= + +It's quite like Nova server groups for VMs, but we are based on affinity_zone +which is a special metadata of aggregate. affinity and anti-affinity policies +make sure servers are on the same or different affinity zones. + +Create a Server Group +--------------------- + +#. If you want all servers to run on the same affinity zone, create a group with +`affinity` policy. + + For example: + + .. code-block:: console + + $ openstack baremetalcompute server group create --policy affinity Affi + +------------+--------------------------------------+ + | Field | Value | + +------------+--------------------------------------+ + | uuid | 5ffe7cc8-c793-4568-be3f-654bc9231acd | + | name | Affi | + | user_id | d4479638a8594d359d7f6115980b08da | + | project_id | 378d5add81b44d3e9afc5b99c31ad209 | + | members | | + | policies | affinity | + +------------+--------------------------------------+ + +#. If you want all servers to run on different affinity zone, create a group with +`anti-affinity` policy. + + For example: + + .. code-block:: console + + $ openstack baremetalcompute server group create --policy anti-affinity Anti + +------------+--------------------------------------+ + | Field | Value | + +------------+--------------------------------------+ + | uuid | 719d7cf9-141f-4c73-b5e8-669f6b4d4b89 | + | name | Anti | + | user_id | d4479638a8594d359d7f6115980b08da | + | project_id | 378d5add81b44d3e9afc5b99c31ad209 | + | members | | + | policies | anti-affinity | + +------------+--------------------------------------+ + +Add a server to Server Group +---------------------------- + +You can only add a server to a server group when you create the server. Not afterwards. +To add a server to a server group, use the ``--hint group=$group-uuid`` parameter on +the :command:`openstack baremetalcompute server create` command. + + For example: + + .. code-block:: console + + $ openstack baremetalcompute server create --image IMAGE --flavor gold \ + --key-name KEY --hint group=GROUP --nic net-id=UUID SERVER