diff --git a/source/_static/images/add-guest-os-button.png b/source/_static/images/add-guest-os-button.png new file mode 100644 index 0000000000..3f66eb98fd Binary files /dev/null and b/source/_static/images/add-guest-os-button.png differ diff --git a/source/_static/images/add-guest-os-form.png b/source/_static/images/add-guest-os-form.png new file mode 100644 index 0000000000..435f2f0857 Binary files /dev/null and b/source/_static/images/add-guest-os-form.png differ diff --git a/source/_static/images/add-guest-os-mapping-button.png b/source/_static/images/add-guest-os-mapping-button.png new file mode 100644 index 0000000000..d59a8885b1 Binary files /dev/null and b/source/_static/images/add-guest-os-mapping-button.png differ diff --git a/source/_static/images/guest-os-button.png b/source/_static/images/guest-os-button.png new file mode 100644 index 0000000000..c04c265fdf Binary files /dev/null and b/source/_static/images/guest-os-button.png differ diff --git a/source/_static/images/guest-os-details-form.png b/source/_static/images/guest-os-details-form.png new file mode 100644 index 0000000000..4c926371d5 Binary files /dev/null and b/source/_static/images/guest-os-details-form.png differ diff --git a/source/_static/images/guest-os-mapping-button.png b/source/_static/images/guest-os-mapping-button.png new file mode 100644 index 0000000000..e9f85e90c4 Binary files /dev/null and b/source/_static/images/guest-os-mapping-button.png differ diff --git a/source/_static/images/guest-os-mapping-form.png b/source/_static/images/guest-os-mapping-form.png new file mode 100644 index 0000000000..bdea4c6f0b Binary files /dev/null and b/source/_static/images/guest-os-mapping-form.png differ diff --git a/source/_static/images/view-guest-os-mappings-button.png b/source/_static/images/view-guest-os-mappings-button.png new file mode 100644 index 0000000000..158c039919 Binary files /dev/null and b/source/_static/images/view-guest-os-mappings-button.png differ diff --git a/source/adminguide/guest_os.rst b/source/adminguide/guest_os.rst new file mode 100644 index 0000000000..cb90cbe1bf --- /dev/null +++ b/source/adminguide/guest_os.rst @@ -0,0 +1,89 @@ +.. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information# + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +.. |guest-os-button.png| image:: /_static/images/guest-os-button.png + :alt: Guest OS section + +.. |add-guest-os-button.png| image:: /_static/images/add-guest-os-button.png + :alt: Add guest OS button + +.. |view-guest-os-mappings-button.png| image:: /_static/images/view-guest-os-mappings-button.png + :alt: View guest OS mappings button + +.. |guest-os-mapping-button.png| image:: /_static/images/guest-os-mapping-button.png + :alt: Guest OS mapping button + +.. |add-guest-os-mapping-button.png| image:: /_static/images/add-guest-os-mapping-button.png + :alt: Add guest OS mapping button + +CloudStack provides administrators a good control to manage the guest operating systems for the +virtual machines. CloudStack maintains the list of guest operating systems that are supported +by the hypervisors and also provides a way for operators or admins to add new guest OSs based on the need. +For an operating system to be supported to CloudStack for the virtual machines, it has to be added in CloudStack +and also need to have a mapping with the actual operating system name supported by hypervisor. + +Under "Configuration" section there are sub-sections for guest operating system. + +Guest OS +--------- + +A list of supported guest operating systems are shown under |guest-os-button.png| and also one can add new operating systems. + +To add a new guest OS, click on the button |add-guest-os-button.png| and following details needs to be provided: + +- **OS name** : Name of the operating system which will be displayed to the users. + +- **OS category** : Category of the operating system to which it belongs, eg. Windows, CentOS, Debian, etc. + +.. image:: /_static/images/add-guest-os-form.png + :width: 400px + :align: center + :alt: Guest OS dialog box + +Operator also need to add mapping with the actual operating system name supported by hypervisor as below. + +Guest OS hypervisor mapping +---------------------------- +Existing mappings are shown here and also one can add new mapping to an operating system. +To view the mappings of an existing guest OS click on |view-guest-os-mappings-button.png| under guest OS details. + +.. image:: /_static/images/guest-os-details-form.png + :width: 400px + :align: center + :alt: Guest OS details form + +To a new mapping, inside the sub-section |guest-os-mapping-button.png| click on |add-guest-os-mapping-button.png| +and following details needs to be provided. + +- **OS type** : Select the operating system type to which mapping needs to be created. + +- **Hypervisor** : Name of the hypervisor. + +- **Hypervisor version** : Specific version of the hypervisor. The exact version number found from hypervisor capabilities list. + +- **Hypervisor mapping name** : Name of the operating system specific to the hypervisor. Eg. For CentOS 5.0 (64-bit) in VMware + the specific name is "centos64Guest". + +- **Check OS name with hypervisor** : A toggle button to specify whether to verify the hypervisor mapping name with available + hypervisor. + +- **Force** : A toggle button to force add a user defined guest os mapping, overrides any existing user defined mapping. + +.. image:: /_static/images/guest-os-mapping-form.png + :width: 400px + :align: center + :alt: Guest OS mapping form + +Operator can also do operations like edit and delete guest OS and its hypervisor mappings. \ No newline at end of file