diff --git a/docs/en-US/add-clusters-kvm-xenserver.xml b/docs/en-US/add-clusters-kvm-xenserver.xml new file mode 100644 index 00000000000..ad5737191fd --- /dev/null +++ b/docs/en-US/add-clusters-kvm-xenserver.xml @@ -0,0 +1,53 @@ + + +%BOOK_ENTITIES; +]> + +
+ Add Cluster: KVM or XenServer + These steps assume you have already installed the hypervisor on the hosts and logged in to + the &PRODUCT; UI. + + + In the left navigation, choose Infrastructure. In Zones, click View More, then click the + zone in which you want to add the cluster. + + + Click the Compute tab. + + + In the Clusters node of the diagram, click View All. + + + Click Add Cluster. + + + Choose the hypervisor type for this cluster. + + + Choose the pod in which you want to create the cluster. + + + Enter a name for the cluster. This can be text of your choosing and is not used by + &PRODUCT;. + + + Click OK. + + +
diff --git a/docs/en-US/add-clusters-vsphere.xml b/docs/en-US/add-clusters-vsphere.xml new file mode 100644 index 00000000000..d9e78d28476 --- /dev/null +++ b/docs/en-US/add-clusters-vsphere.xml @@ -0,0 +1,121 @@ + + +%BOOK_ENTITIES; +]> + +
+ Add Cluster: vSphere + Host management for vSphere is done through a combination of vCenter and the &PRODUCT; admin + UI. &PRODUCT; requires that all hosts be in a &PRODUCT; cluster, but the cluster may consist of + a single host. As an administrator you must decide if you would like to use clusters of one host + or of multiple hosts. Clusters of multiple hosts allow for features like live migration. + Clusters also require shared storage such as NFS or iSCSI. + For vSphere servers, we recommend creating the cluster of hosts in vCenter and then adding + the entire cluster to &PRODUCT;. Follow these requirements: + + + Do not put more than 8 hosts in a vSphere cluster + + + Make sure the hypervisor hosts do not have any VMs already running before you add them + to &PRODUCT;. + + + To add a vSphere cluster to &PRODUCT;: + + + Create the cluster of hosts in vCenter. Follow the vCenter instructions to do this. You + will create a cluster that looks something like this in vCenter. + + + + + + vsphereclient.png: vSphere client + + + + + Log in to the UI. + + + In the left navigation, choose Infrastructure. In Zones, click View More, then click the + zone in which you want to add the cluster. + + + Click the Compute tab, and click View All on Pods. Choose the pod to which you want to + add the cluster. + + + Click View Clusters. + + + Click Add Cluster. + + + In Hypervisor, choose VMware. + + + Provide the following information in the dialog. The fields below make reference to + values from vCenter. + + + Cluster Name. Enter the name of the cluster you created in vCenter. For example, + "cloud.cluster.2.2.1" + + + vCenter Host. Enter the hostname or IP address of the vCenter server. + + + vCenter Username. Enter the username that &PRODUCT; should use to connect to + vCenter. This user must have all administrative privileges. + + + vCenter Password. Enter the password for the user named above + + + vCenter Datacenter. Enter the vCenter datacenter that the cluster is in. For + example, "cloud.dc.VM". + If you have enabled Nexus dvSwitch in the environment, the following parameters for + dvSwitch configuration are displayed: + + + Nexus dvSwitch IP Address: The IP address of the Nexus VSM appliance. + + + Nexus dvSwitch Username: The username required to access the Nexus VSM + applicance. + + + Nexus dvSwitch Password: The password associated with the username specified + above. + + + + + + addcluster.png: add cluster + + + There might be a slight delay while the cluster is provisioned. It will + automatically display in the UI + + + + +
diff --git a/docs/en-US/api-overview.xml b/docs/en-US/api-overview.xml new file mode 100644 index 00000000000..a541049e116 --- /dev/null +++ b/docs/en-US/api-overview.xml @@ -0,0 +1,38 @@ + + +%BOOK_ENTITIES; +]> + + + &PRODUCT; API + The &PRODUCT; API is a low level API that has been used to implement the &PRODUCT; web UIs. + It is also a good basis for implementing other popular APIs such as EC2/S3 and emerging DMTF + standards. + Many &PRODUCT; API calls are asynchronous. These will return a Job ID immediately when + called. This Job ID can be used to query the status of the job later. Also, status calls on + impacted resources will provide some indication of their state. + The API has a REST-like query basis and returns results in XML or JSON. + See the + Developer’s Guide and the API + Reference. + + + + diff --git a/docs/en-US/create-vr-network-offering.xml b/docs/en-US/create-vr-network-offering.xml new file mode 100644 index 00000000000..317e3c200a1 --- /dev/null +++ b/docs/en-US/create-vr-network-offering.xml @@ -0,0 +1,108 @@ + + +%BOOK_ENTITIES; +]> + +
+ Creating and Changing a Virtual Router Network Offering + To create the network offering in association with a virtual router system service + offering: + + + Log in to the &PRODUCT; UI as a user or admin. + + + First, create a system service offering, for example: VRsystemofferingHA. + For more information on creating a system service offering, see . + + + From the Select Offering drop-down, choose Network Offering. + + + Click Add Network Offering. + + + In the dialog, make the following choices: + + + Name. Any desired name for the network + offering. + + + Description. A short description of the offering + that can be displayed to users. + + + Network Rate. Allowed data transfer rate in MB per + second. + + + Traffic Type. The type of network traffic that will + be carried on the network. + + + Guest Type. Choose whether the guest network is + isolated or shared. For a description of these terms, see . + + + Specify VLAN. (Isolated guest networks only) + Indicate whether a VLAN should be specified when this offering is used. + + + Supported Services. Select one or more of the + possible network services. For some services, you must also choose the service provider; + for example, if you select Load Balancer, you can choose the &PRODUCT; virtual router or + any other load balancers that have been configured in the cloud. Depending on which + services you choose, additional fields may appear in the rest of the dialog box. For + more information, see + + + System Offering. Choose the system service offering + that you want virtual routers to use in this network. In this case, the default “System + Offering For Software Router” and the custom “VRsystemofferingHA” are available and + displayed. + + + + + Click OK and the network offering is created. + + + To change the network offering of a guest network to the virtual router service + offering: + + + Select Network from the left navigation pane. + + + Select the guest network that you want to offer this network service to. + + + Click the Edit button. + + + From the Network Offering drop-down, select the virtual router network offering you have + just created. + + + Click OK. + + +
diff --git a/docs/en-US/global-config.xml b/docs/en-US/global-config.xml new file mode 100644 index 00000000000..8bc08035d9b --- /dev/null +++ b/docs/en-US/global-config.xml @@ -0,0 +1,54 @@ + + +%BOOK_ENTITIES; +]> + +
+ Setting Global Configuration Parameters + &PRODUCT; provides parameters that you can set to control many aspects of the cloud. When + &PRODUCT; is first installed, and periodically thereafter, you might need to modify these + settings. + + + Log in to the UI as administrator. + + + In the left navigation bar, click Global Settings. + + + In Select View, choose one of the following: + + + Global Settings. This displays a list of the parameters with brief descriptions and + current values. + + + Hypervisor Capabilities. This displays a list of hypervisor versions with the + maximum number of guests supported for each. + + + + + Use the search box to narrow down the list to those you are interested in. + + + Click the Edit icon to modify a value. If you are viewing Hypervisor Capabilities, you + must click the name of the hypervisor first to display the editing screen. + + +
diff --git a/docs/en-US/networks.xml b/docs/en-US/networks.xml new file mode 100644 index 00000000000..d4ed76d4d0c --- /dev/null +++ b/docs/en-US/networks.xml @@ -0,0 +1,48 @@ + + +%BOOK_ENTITIES; +]> + + + Managing Networks and Traffic + In a &PRODUCT;, guest VMs can communicate with each other using shared infrastructure with + the security and user perception that the guests have a private LAN. The &PRODUCT; virtual + router is the main component providing networking features for guest traffic. + + + + + + + + + + + + + + + + + + + + diff --git a/docs/en-US/provisioning.xml b/docs/en-US/provisioning.xml new file mode 100644 index 00000000000..ec28451519c --- /dev/null +++ b/docs/en-US/provisioning.xml @@ -0,0 +1,25 @@ + + +%BOOK_ENTITIES; +]> + + + Provisioning Your Cloud Infrastructure + + + diff --git a/docs/en-US/storage-overview.xml b/docs/en-US/storage-overview.xml new file mode 100644 index 00000000000..bebf441ab60 --- /dev/null +++ b/docs/en-US/storage-overview.xml @@ -0,0 +1,27 @@ + + +%BOOK_ENTITIES; +]> + +
+ Storage Overview + &PRODUCT; defines two types of storage: primary and secondary. Primary storage can be + accessed by either iSCSI or NFS. Additionally, direct attached storage may be used for primary + storage. Secondary storage is always accessed using NFS. + There is no ephemeral storage in &PRODUCT;. All volumes on all nodes are persistent. +
diff --git a/docs/en-US/virtual-machines.xml b/docs/en-US/virtual-machines.xml new file mode 100644 index 00000000000..7c74932b649 --- /dev/null +++ b/docs/en-US/virtual-machines.xml @@ -0,0 +1,34 @@ + + +%BOOK_ENTITIES; +]> + + + Working With Virtual Machines + + + + + + + + + + + +