diff --git a/doc/source/admin/compute.rst b/doc/source/admin/compute.rst index 91e89467..b97bb06f 100644 --- a/doc/source/admin/compute.rst +++ b/doc/source/admin/compute.rst @@ -1,5 +1,7 @@ -Manage instances (Compute) -========================== +Manage instances (Compute tab) +============================== + +For more information, refer to the :ref:`compute-tab`. Manage compute nodes -------------------- diff --git a/doc/source/admin/dashboard.rst b/doc/source/admin/dashboard.rst index 835e795c..bf7504d0 100644 --- a/doc/source/admin/dashboard.rst +++ b/doc/source/admin/dashboard.rst @@ -1,5 +1,5 @@ Openstack Dashboard ==================== -Administrator tab ------------------- +Administrator page +------------------- diff --git a/doc/source/admin/identity.rst b/doc/source/admin/identity.rst index 9dfeb994..fde2e6b2 100644 --- a/doc/source/admin/identity.rst +++ b/doc/source/admin/identity.rst @@ -1,5 +1,21 @@ -Manage projects, users and roles(Identity) -========================================== +Manage projects, users and roles (Identity tab) +================================================ + +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 +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 +with projects or domains. A user with no assigned roles has no access +to OpenStack resources. + +OpenStack Identity Service is the module in the OpenStack framework that +manages the authentication, service rules and service token functions. +For detailed information, refer to the +`OpenStack Keystone Guide `__. Create a role ------------- diff --git a/doc/source/admin/storage.rst b/doc/source/admin/storage.rst index 925e7969..deaaa94e 100644 --- a/doc/source/admin/storage.rst +++ b/doc/source/admin/storage.rst @@ -1,8 +1,49 @@ -Manage volumes (Storage) -======================== +Manage volumes (Storage tab) +============================ + +As an administrative user, you can manage volumes and volume types for users +in various projects. You can create and delete volume types, and you can view +and delete volumes. For more information, refer to the :ref:`storage-tab`. Create a volume type -------------------- +#. Log in to the dashboard. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Storage` tab and + click :guilabel:`Volume Types` category. + +#. Click :guilabel:`Create Volume Type`. + +#. In the :guilabel:`Create Volume Type` dialog box, specify the following values. + + :guilabel:`Name`: Specify a name to identify the volume type. + + :guilabel:`Description`: A human-readable description for the resource. + + :guilabel:`Shared`: "Shared" volume can be mounted on multiple instances. + + :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. + +#. Click :guilabel:`OK`. + +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. + +#. On the :guilabel:`Administrator` page, open the :guilabel:`Storage` tab and + click :guilabel:`Volume Types` category. + +#. Select the check boxes for the volume types that you want to delete. + +#. Click :guilabel:`Delete` and confirm your choice. + + A message indicates whether the action was successful. diff --git a/doc/source/user/compute.rst b/doc/source/user/compute.rst index a911f434..20125d8d 100644 --- a/doc/source/user/compute.rst +++ b/doc/source/user/compute.rst @@ -1,23 +1,40 @@ -Launch and manage instances (Compute) -===================================== +.. _compute-tab: + +========================================= +Launch and manage instances (Compute tab) +========================================= Upload an image --------------- + + Import a key pair ----------------- + + Launch an instance ------------------ + + Create an instance snapshot ---------------------------- + + Manage an instance ------------------ + + Allocate a floating IP address to an instance ---------------------------------------------- + + Connect to instance by using SSH --------------------------------- + + diff --git a/doc/source/user/dashboard.rst b/doc/source/user/dashboard.rst index 706b0306..09503997 100644 --- a/doc/source/user/dashboard.rst +++ b/doc/source/user/dashboard.rst @@ -1,8 +1,8 @@ Openstack Dashboard =================== -User tab --------- +User page +---------- -Console tab ------------ +Console page +------------- diff --git a/doc/source/user/network.rst b/doc/source/user/network.rst index ff223029..40cb7e85 100644 --- a/doc/source/user/network.rst +++ b/doc/source/user/network.rst @@ -1,17 +1,186 @@ -Create and manage networks -=========================== +.. _network-tab: + +======================================== +Create and manage networks (Network tab) +======================================== + +The OpenStack Networking service provides a scalable system for managing the +network connectivity within an OpenStack cloud deployment. It handles the +creation and management of a virtual networking infrastructure, including +networks, switches, subnets, and routers. Advanced services such as firewalls +or virtual private network (VPN) can also be used. + +Networking in OpenStack is complex. This section provides the basic +instructions for creating a network and a router. For detailed +information about managing networks, refer to the `OpenStack Networking Guide +`__. create a network ---------------- +#. 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:`Network` tab and + click :guilabel:`Networks` category. + +#. Click :guilabel:`Create Network`. + +#. In the :guilabel:`Create Network` dialog box, specify the following values. + + :guilabel:`Network Name`: Specify a name to identify the network. + + :guilabel:`Description`: A human-readable description for the resource. + + :guilabel:`Shared`: Share the network with other projects. Non admin users + are not allowed to set shared option. + + :guilabel:`Available Zone`: Select a availability zone for the network. + + :guilabel:`Port Security Enabled`: Select the port security status of the network. + + :guilabel:`Create Subnet`: Select this check box to create a subnet. + + You do not have to specify a subnet when you create a network, but if + you do not specify a subnet, the network can not be attached to an instance. + + :guilabel:`Subnet Name`: Specify a name for the subnet. + + :guilabel:`CIDR`: Specify the IP address for the subnet. + + :guilabel:`IP Version`: Select IPv4 or IPv6. + + :guilabel:`Gateway IP`: Specify an IP address for a specific gateway. This + parameter is optional. + + :guilabel:`Disable Gateway`: Select this check box to disable a gateway IP + address. + + :guilabel:`DHCP`: Select this check box to enable DHCP. + + :guilabel:`Allocation Pools`: Specify IP address pools. + + :guilabel:`DNS`: Specify the DNS server. + + :guilabel:`Host Routes`: Specify the IP address of host routes. + +#. Click :guilabel:`OK`. + + The dashboard shows the network on the :guilabel:`Networks` tab. + create a router ---------------- +#. 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:`Network` tab and + click :guilabel:`Routers` category. + +#. Click :guilabel:`Create Router`. + +#. In the :guilabel:`Create Router` dialog box, specify the following values. + + :guilabel:`Name`: Specify a name to identify the router. + + :guilabel:`Open External Gateway`: Select this check box to specify external gateway. + + :guilabel:`External Gateway`: Specify external gateway for the router. + + Click :guilabel:`OK`, and the new router is now displayed in + the :guilabel:`Routers` tab. + +#. To connect a private network to the newly created router, perform the + following steps: + + A) On the :guilabel:`Routers` tab, select :guilabel:`More` of the router, + click :guilabel:`connect Subnet`. + + C) In the :guilabel:`Connect Subnet` dialog box, select a :guilabel:`Network` + and :guilabel:`Subnet`. + +#. Click :guilabel:`OK`. + +You have successfully created the router. You can view the new topology +from the :guilabel:`Topology` tab. + create a port -------------- +#. 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:`Network` tab and + +#. On the :guilabel:`Project` tab, click :guilabel:`Networks` category. +click :guilabel:`Ports` category. + +#. Click :guilabel:`Create Virtual Adapter`. + +#. In the :guilabel:`Create Virtual Adapter` dialog box, specify the following values. + + :guilabel:`Name`: Specify name to identify the port. + + :guilabel:`Owned Network`: Select a network attached to the port. + + :guilabel:`Owned Subnet`: Select a subnet attached to the port. + + If you specify both a subnet ID and an IP address, OpenStack tries to + allocate the IP address on that subnet to the port. + + If you specify only a subnet ID, OpenStack allocates an available IP + from that subnet to the port. + + :guilabel:`Port Security`: Select this check box to specify security group. + + :guilabel:`Security Group`: Select a security groups applied to the port. + +#. Click :guilabel:`OK`. + + The new port is now displayed in the :guilabel:`Ports` list. + create a fip ------------- +#. 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:`Network` tab and + click :guilabel:`Floating IPs` category. + +#. Click :guilabel:`Allocate IP`. + +#. In the :guilabel:`Allocate IP` dialog box, specify the following values. + + :guilabel:`Network`: Specify a network associated with the floating IP. + + :guilabel:`Description`: A human-readable description for the resource. + + :guilabel:`Batch Allocate`: Select this check box to specify the number + of batch creation. + + :guilabel:`Count`: Specify the number of batch creation. + +#. Click :guilabel:`OK`. + + The dashboard shows the floating ip on the :guilabel:`Floating IPs` tab. + create a security group ------------------------ + +#. 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:`Network` tab and + click :guilabel:`Security Groups` category. + +#. Click :guilabel:`Create Security Group`. + +#. In the :guilabel:`Create Security Group` dialog box, specify :guilabel:`Name` + and :guilabel:`Description`, click :guilabel:`OK` and the new security group + is now displayed in the :guilabel:`Security Groups` list. diff --git a/doc/source/user/storage.rst b/doc/source/user/storage.rst index 8c64d67b..5f90a58c 100644 --- a/doc/source/user/storage.rst +++ b/doc/source/user/storage.rst @@ -1,20 +1,177 @@ -Create and manage volumes (Storage) -=================================== +.. _storage-tab: + +======================================= +Create and manage volumes (Storage tab) +======================================= + +A volume is a detachable block storage device similar to a USB hard drive. +You can attach a volume to a running instance or detach a volume and +attach it to another instance at any time. You can also create a snapshot +from or delete a volume. Only administrative users can create volume types. + +OpenStack Block Storage enables you to add extra block-level storage to +your OpenStack Compute instances. For detailed information, refer to the +`OpenStack Cinder Guide +`__. Create a volume ---------------- +#. 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:`Storage` tab and + click :guilabel:`Volumes` category. + +#. Click :guilabel:`Create Volume`. + +#. On the :guilabel:`Create Volume` page, specify the following values. + + :guilabel:`Available Zone`: Select a availability zone for the volume. + + :guilabel:`Data Source Type`: Select one of the following options: + + * Blank Volume: If you choose this option, a new field for + :guilabel:`Volume Type` displays. You can select the volume type + from the list. You can create an empty volume. An empty volume does + not contain a file system or a partition table. + + * Image: If you choose this option, a new field for + :guilabel:`Operating System` displays. You can select the image + from the list. + + * Volume Snapshot: If you choose this option, a new field for + :guilabel:`Volume Snapshot` displays. You can select the + snapshot from the list. + + :guilabel:`Volume Type`: Specify a volume type to choose an appropriate + storage back end. + + :guilabel:`Capacity (GiB)`: Specify the size of the volume, in gibibytes (GiB). + + :guilabel:`Name`: Specify a name to identify the volume. + +#. Click :guilabel:`Confirm`. + +You have successfully created the volume. You can view the volume from +the :guilabel:`Volumes` tab. + Attach a volume to an instance ------------------------------- +After you create one or more volumes, you can attach them to instances. +You can attach a volume to one instance at a time. + +#. 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:`Storage` tab and + click :guilabel:`Volumes` category. + +#. Select the volume to add to an instance. + +#. In the :guilabel:`Action` column, select :guilabel:`Instance Related` + and click :guilabel:`Attach`. + +#. In the :guilabel:`Attach` dialog box, select an instance. + +#. Click :guilabel:`OK`. + + The dashboard shows the instance to which the volume is now attached + and the device name. + +You can view the status of a volume in the Volumes tab of the dashboard. +The volume is either Available or In-Use. + +Now you can log in to the instance and mount, format, and use the disk. + Detach a volume from 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:`Storage` tab and + click :guilabel:`Volumes` category. + +#. In the :guilabel:`Action` column of the volume, select + :guilabel:`Instance Related` and click :guilabel:`Detach`. + +#. In the :guilabel:`Detach` dialog box, select an instance. + +#. Click :guilabel:`OK`. + +A message indicates whether the action was successful. + Create a snapshot from a volume -------------------------------- +#. 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:`Storage` tab and + click :guilabel:`Volumes` category. + +#. Select a volume from which to create a snapshot. + +#. In the :guilabel:`Action` column, select :guilabel:`Data Protection` and + click :guilabel:`Create Snapshot`. + +#. In the :guilabel:`Create Volume Snapshot` dialog box, enter a snapshot name. + +#. Click :guilabel:`OK`. + + The dashboard shows the new volume snapshot in :guilabel:`Volume Snapshots` tab. + Edit a volume -------------- +#. 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:`Storage` tab and + click :guilabel:`Volumes` category. + +#. In the :guilabel:`Action` column of the volume, click :guilabel:`Edit`. + +#. In the :guilabel:`Edit` dialog box, update the name and description + of the volume. + +#. Click :guilabel:`OK`. + + .. note:: + + You can extend a volume by using the :guilabel:`Extend Volume` + option available in the :guilabel:`More` dropdown list and entering the + new value for volume size. + Delete a volume ---------------- + +When you delete an instance, the data in its attached volumes is not +deleted. + +#. 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:`Storage` tab and + click :guilabel:`Volumes` category. + +#. Select the check boxes for the volumes that you want to delete. + +#. Click :guilabel:`Delete` and confirm your choice. + + .. note:: + + If you select the :guilabel:`cascading deletion` check box, when the + volume has snapshots, the associated snapshot will be automatically + deleted first, and then the volume will be deleted, thereby improving + the success rate of deleting the volume. + + A message indicates whether the action was successful. diff --git a/doc/source/user/supported-browsers.rst b/doc/source/user/supported-browsers.rst index 1a9b3664..7138bcf5 100644 --- a/doc/source/user/supported-browsers.rst +++ b/doc/source/user/supported-browsers.rst @@ -1,2 +1,4 @@ Supported Browsers ================== + +Skyline is primarily tested and supported on the latest version of Chrome.