diff --git a/doc/source/admin/compute.rst b/doc/source/admin/compute.rst index b97bb06f..dae61193 100644 --- a/doc/source/admin/compute.rst +++ b/doc/source/admin/compute.rst @@ -1,19 +1,124 @@ Manage instances (Compute tab) ============================== +As an administrative user, you can manage compute nodes. You can create +and delete flavors, and you can create and manage host aggregates. For more information, refer to the :ref:`compute-tab`. -Manage compute nodes +Manage compute hosts -------------------- +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Compute` tab and + click :guilabel:`Hypervisors` category. + +#. Click :guilabel:`Compute Hosts` tab. + + On the :guilabel:`Compute Hosts` page, you can :guilabel:`Enable` or + :guilabel:`Disable` the compute hosts. + Create a flavor --------------- +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Compute` tab and + click :guilabel:`Flavors` category. + +#. Click :guilabel:`Create Flavor`. + +#. On the :guilabel:`Params Setting` page, specify the following values. + + :guilabel:`Architecture`: Select one of the following options: + + * X86 Architecture: If choose this option, you can select + :guilabel:`General Purpose`, :guilabel:`Compute Optimized`, + :guilabel:`Memory Optimized` or :guilabel:`High Clock Speed` as + flavor :guilabel:`Type`. + + * Heterogeneous Computing: If choose this option, you can + select :guilabel:`Compute Optimized Type with GPU` or + :guilabel:`Visualization Compute Optimized Type with GPU` as + flavor :guilabel:`Type`. + + :guilabel:`Name`: Enter the flavor name. + + :guilabel:`CPU(Core)`: Enter the number of virtual CPUs to use. + + :guilabel:`Ram Size (GiB)`: Enter the amount of RAM to use, in gigabytes. + + :guilabel:`NUMA Nodes`: Enter the number of Non-Uniform Memory Access nodes. + +#. Click :guilabel:`Next: Access Type Setting`. + +#. On the :guilabel:`Access Type Setting` page, specify the following values. + + :guilabel:`Access Type`: Select one of the following options: + + * :guilabel:`Public``: Select this option to make the flavor publicly visible. + + * :guilabel:`Access Control`: If choose this option, you can select + projects from :guilabel:`Access Control` list to determine which projects + are visible to the flavor. + +#. Click :guilabel:`Confirm`. + + The new flavor is now displayed in the :guilabel:`Flavors` list. + Delete a flavor --------------- +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Compute` tab and + click :guilabel:`Flavors` category. + +#. Select the check boxes for the flavors that you want to delete. + +#. Click :guilabel:`Delete` and confirm your choice. + + A message indicates whether the action was successful. + Create a host aggregate ----------------------- +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Compute` tab and + click :guilabel:`Host Aggregates` category. + +#. Click :guilabel:`Host Aggregate` tab. + +#. Click :guilabel:`Create Host Aggregate`. + +#. In the :guilabel:`Create Host Aggregate` dialog box, specify the following values. + + - :guilabel:`Name`: The host aggregate name. + + - :guilabel:`Create new AZ`: + + - If set this option to :guilabel:`Yes`, specify + :guilabel:`New Availability Zone` name to create new availability zone. + + - If set this option to :guilabel:`No`, select a + :guilabel:`Availability Zone` of the host aggregate. + +#. Click :guilabel:`OK`. + Manage host aggregates ---------------------- + +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Compute` tab and + click :guilabel:`Host Aggregates` category. + +#. Click :guilabel:`Host Aggregate` tab. + +#. In the :guilabel:`Action` column of the host aggregate, click :guilabel:`Manage Host`. + +#. In the :guilabel:`Manage Host` dialog box, add hosts to the aggregate or + remove hosts from it. + +#. Click :guilabel:`OK`. diff --git a/doc/source/admin/identity.rst b/doc/source/admin/identity.rst index fde2e6b2..d3ada6c4 100644 --- a/doc/source/admin/identity.rst +++ b/doc/source/admin/identity.rst @@ -5,7 +5,7 @@ OpenStack administrators can create projects, create accounts for new users and create roles. A project is the base unit of resource ownership. Resources are owned by -a specific project. A project is owned by a specific domain.A role is a +a specific project. A project is owned by a specific domain. A role is a personality that a user assumes to perform a specific set of operations. A role includes a set of rights and privileges. A user is an individual consumer that is owned by a domain. A role explicitly associates a user @@ -20,26 +20,160 @@ For detailed information, refer to the Create a role ------------- +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Identity` tab and + click :guilabel:`Roles` category. + +#. Click :guilabel:`Create Role`. + +#. In the :guilabel:`Create Role` dialog box, enter the role :guilabel:`Name` + and :guilabel:`Description`. + +#. Click :guilabel:`OK`. + + The new role is now displayed in the :guilabel:`Roles` list. + Edit a role ----------- +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Identity` tab and + click :guilabel:`Roles` category. + +#. In the :guilabel:`Action` column of the role, click :guilabel:`Edit`. + +#. In the :guilabel:`Edit` dialog box, update :guilabel:`Name` and + :guilabel:`Description` of the role. + +#. Click :guilabel:`OK`. + + A message indicates whether the action was successful. + Delete a role -------------- +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Identity` tab and + click :guilabel:`Roles` category. + +#. Select the check boxes for the roles that you want to delete. + +#. Click :guilabel:`Delete` and confirm your choice. + + A message indicates whether the action was successful. + Add a new project ----------------- +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Identity` tab and + click :guilabel:`Projects` category. + +#. Click :guilabel:`Create Project`. + +#. In the :guilabel:`Create Project` dialog box, enter the Project + :guilabel:`Name`, :guilabel:`Description`, :guilabel:`Status` + and :guilabel:`Affiliated Domain`. + +#. Click :guilabel:`OK`. + + The new project is now displayed in the :guilabel:`Projects` list. + Delete a project ---------------- +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Identity` tab and + click :guilabel:`Projects` category. + +#. Select the check boxes for the projects that you want to delete. + +#. Click :guilabel:`Delete` and confirm your choice. + + A message indicates whether the action was successful. + Update a project ---------------- +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Identity` tab and + click :guilabel:`Projects` category. + +#. In the :guilabel:`Action` column of the project, click :guilabel:`Edit`. + +#. In the :guilabel:`Edit` dialog box, update :guilabel:`Name` and + :guilabel:`Description` of the project. + +#. Click :guilabel:`OK`. + + A message indicates whether the action was successful. + + .. note:: + + You can enable or disable the project by using the :guilabel:`Enable` or + :guilabel:`Forbidden` options available in the :guilabel:`More` dropdown + list. + Add a new user --------------- -Delete a new user ------------------ +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Identity` tab and + click :guilabel:`Users` category. + +#. On the :guilabel:`Create User` page, enter the user :guilabel:`User Name`, + :guilabel:`Password`, :guilabel:`Confirm Password`, :guilabel:`Email`, + :guilabel:`Phone`, :guilabel:`Real Name` and :guilabel:`Status`. + + If you choose :guilabel:`Advanced Options`, new fields for + :guilabel:`Select Project` and :guilabel:`Select User Group` display. You can + assign role to user on project. You can also add user to group. + +#. Click :guilabel:`Confirm`. + + The new user is now displayed in the :guilabel:`Users` list. + +Delete a user +-------------- + +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Identity` tab and + click :guilabel:`Users` category. + +#. Select the check boxes for the users that you want to delete. + +#. Click :guilabel:`Delete` and confirm your choice. + + A message indicates whether the action was successful. Update a user ------------- + +#. Log into the OpenStack Dashboard as the Admin user. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Identity` tab and + click :guilabel:`Users` category. + +#. In the :guilabel:`Action` column of the user, click :guilabel:`Edit`. + +#. In the :guilabel:`Edit` dialog box, update :guilabel:`User Name`, + :guilabel:`Description`, :guilabel:`Email`, :guilabel:`Phone` and + :guilabel:`Real Name` of the user. + +#. Click :guilabel:`OK`. + + A message indicates whether the action was successful. + + .. note:: + + You can enable or disable the user by using the :guilabel:`Enable` or + :guilabel:`Forbidden` options available in the :guilabel:`More` dropdown + list. diff --git a/doc/source/admin/storage.rst b/doc/source/admin/storage.rst index deaaa94e..51dc76ad 100644 --- a/doc/source/admin/storage.rst +++ b/doc/source/admin/storage.rst @@ -8,7 +8,7 @@ and delete volumes. For more information, refer to the :ref:`storage-tab`. Create a volume type -------------------- -#. Log in to the dashboard. +#. Log into the OpenStack Dashboard as the Admin user. #. On the :guilabel:`Administrator` page, open the :guilabel:`Storage` tab and click :guilabel:`Volume Types` category. @@ -25,19 +25,21 @@ Create a volume type :guilabel:`Public`: Select this check box to make the volume type publicly visible. - If you do not choose this check box, a new field for :guilabel:`Access Control` - displays. You can select projects from the list to determine which projects are - visible to the volume type. + .. note:: + + If you do not choose this check box, a new field for + :guilabel:`Access Control` displays. You can select projects from the + list to determine which projects are visible to the volume type. #. Click :guilabel:`OK`. -You have successfully created the volume type. You can view the volume type from -the :guilabel:`Volume Types` tab. + You have successfully created the volume type. You can view the volume + type from the :guilabel:`Volume Types` tab. Delete a volume type -------------------- -#. Log in to the dashboard. +#. Log into the OpenStack Dashboard as the Admin user. #. On the :guilabel:`Administrator` page, open the :guilabel:`Storage` tab and click :guilabel:`Volume Types` category. diff --git a/doc/source/user/compute.rst b/doc/source/user/compute.rst index 20125d8d..992f8095 100644 --- a/doc/source/user/compute.rst +++ b/doc/source/user/compute.rst @@ -4,37 +4,171 @@ Launch and manage instances (Compute tab) ========================================= -Upload an image ---------------- +The OpenStack Compute service provides a way to provision compute instances +(aka virtual servers). It supports creating virtual machines, baremetal +servers (through the use of ironic), and has limited support for system +containers. For detailed information, refer to the +`OpenStack Nova Guide `__. - - -Import a key pair +Create a key pair ----------------- +#. Log in to the dashboard. +#. Select the appropriate project from the Switch Project menu at the top left. + +#. On the :guilabel:`Console` page, open the :guilabel:`Compute` tab and + click :guilabel:`Key Pairs` category. + +#. Click :guilabel:`Create Keypair`. + +#. In the :guilabel:`Create Volume` dialog box, select one of + :guilabel:`Create Type` options: + + * :guilabel:`Create Keypair`: If you choose this option, enter a + :guilabel:`Name`. + + * :guilabel:`Import Keypair`: If you choose this option, a new field for + :guilabel:`Public Key` displays. Enter the :guilabel:`Name` of your key + pair, copy the public key into the :guilabel:`Public Key` box. + +#. Click :guilabel:`OK`. + + The Dashboard lists the key pair on the :guilabel:`Key Pairs` tab. Launch an instance ------------------ +#. Log in to the dashboard. +#. Select the appropriate project from the Switch Project menu at the top left. + +#. On the :guilabel:`Console` page, open the :guilabel:`Compute` tab and + click :guilabel:`Instances` category. + +#. Click :guilabel:`Create Instance`. + +#. On the :guilabel:`Create Instance` page, enter the instance values. + +#. Click :guilabel:`Next: Network Config`. + +#. Click :guilabel:`Next: System Config`. + +#. Click :guilabel:`Next: Confirm Config` and confirm your choice. + + The instance are created and you can wait for a few seconds to + follow the changes of the instance list data or manually refresh the data + to get the final display result. Create an instance snapshot ---------------------------- +#. Log in to the dashboard. +#. Select the appropriate project from the Switch Project menu at the top left. -Manage an instance ------------------- +#. On the :guilabel:`Console` page, open the :guilabel:`Compute` tab and + click :guilabel:`Instances` category. +#. Select an instance to create a snapshot from it. +#. In the :guilabel:`Action` column, select :guilabel:`Backups & Snapshots` and + click :guilabel:`Create Snapshot`. + +#. In the :guilabel:`Create Instance Snapshot` dialog box, enter a snapshot name. + +#. Click :guilabel:`OK`. + + The dashboard shows the new instance snapshot in :guilabel:`Instance Snapshots` tab. + +Control the state of an instance +--------------------------------- + +#. Log in to the dashboard. + +#. Select the appropriate project from the Switch Project menu at the top left. + +#. On the :guilabel:`Console` page, open the :guilabel:`Compute` tab and + click :guilabel:`Instances` category. + +#. Select the instance for which you want to change the state. + +#. In the :guilabel:`Action` column of the instance, click + :guilabel:`Instance Status` and select the status. Allocate a floating IP address to an instance ---------------------------------------------- +#. Log in to the dashboard. +#. Select the appropriate project from the Switch Project menu at the top left. -Connect to instance by using SSH ---------------------------------- +#. On the :guilabel:`Console` page, open the :guilabel:`Compute` tab and + click :guilabel:`Instances` category. +#. In the :guilabel:`Action` column, select :guilabel:`Related Resources` + and click :guilabel:`Associate Floating IP`. +#. In the :guilabel:`Associate Floating IP` dialog box, select + :guilabel:`Instance IP` and :guilabel:`Floating Ip Address`. + +#. Click :guilabel:`OK`. + +.. note:: + + To disassociate an IP address from an instance, click the + :guilabel:`Disassociate Floating Ip` button. + +Upload an image +--------------- + +Images are used to create virtual machine instances within the cloud. +For information about creating image files, see the +`OpenStack Glance Guide `__. + +#. Log in to the dashboard. + +#. Select the appropriate project from the Switch Project menu at the top left. + +#. On the :guilabel:`Console` page, open the :guilabel:`Compute` tab and + click :guilabel:`Images` category. + +#. Click :guilabel:`Create Image`. + +#. On the :guilabel:`Create Image` page, enter the following values: + + :guilabel:`Name`: The name of the image. + + :guilabel:`Upload Type`: Select one of the following options: + + * Upload File: If choose this option, click :guilabel:`Click to Upload` + to upload the binary image data file. + + * File URL: If choose this option, enter the :guilabel:`File URL`. + + :guilabel:`Format`: Select the image format (for example, QCOW2) for the image. + + :guilabel:`OS`: Select the image operating system (for example, CentOS). + + :guilabel:`OS Version`: The image operating system version. + + :guilabel:`OS Admin`: The administrator name of image operating system. + in general, administrator for Windows, root for Linux. + + :guilabel:`Min System Disk (GiB)`: Amount of disk space in GB that is + required to boot the image. + + :guilabel:`Min Memory (GiB)`: Amount of Memory in GB that is required + to boot the image. + + :guilabel:`Protected`: Image protection for deletion. + + :guilabel:`Usage Type`: Select usage type (for example, Common Server) + for the image. + + :guilabel:`Description`: A human-readable description for the resource. + +#. Click :guilabel:`Confirm`. + + The image is queued to be uploaded. It might take some time before + the status changes from Queued to Active. diff --git a/doc/source/user/storage.rst b/doc/source/user/storage.rst index 5f90a58c..f56449d9 100644 --- a/doc/source/user/storage.rst +++ b/doc/source/user/storage.rst @@ -54,8 +54,8 @@ Create a volume #. Click :guilabel:`Confirm`. -You have successfully created the volume. You can view the volume from -the :guilabel:`Volumes` tab. + You have successfully created the volume. You can view the volume from + the :guilabel:`Volumes` tab. Attach a volume to an instance ------------------------------- @@ -104,7 +104,7 @@ Detach a volume from an instance #. Click :guilabel:`OK`. -A message indicates whether the action was successful. + A message indicates whether the action was successful. Create a snapshot from a volume --------------------------------