Skip to content

Commit 98f4542

Browse files
committed
fixing some docs
1 parent a4906c6 commit 98f4542

13 files changed

Lines changed: 777 additions & 4 deletions

docs/en-US/add-load-balancer-rule.xml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,6 @@
7070
the algorithm for the stickiness policy. See Sticky Session Policies for Load Balancer
7171
Rules.</para>
7272
</listitem>
73-
<listitem>
74-
<para><emphasis role="bold">AutoScale</emphasis>: Click Configure and complete the
75-
AutoScale configuration as explained in <xref linkend="autoscale"/>.</para>
76-
</listitem>
7773
</itemizedlist>
7874
</listitem>
7975
<listitem>

docs/en-US/add-more-clusters.xml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<!-- Licensed to the Apache Software Foundation (ASF) under one
7+
or more contributor license agreements. See the NOTICE file
8+
distributed with this work for additional information
9+
regarding copyright ownership. The ASF licenses this file
10+
to you under the Apache License, Version 2.0 (the
11+
"License"); you may not use this file except in compliance
12+
with the License. You may obtain a copy of the License at
13+
http://www.apache.org/licenses/LICENSE-2.0
14+
Unless required by applicable law or agreed to in writing,
15+
software distributed under the License is distributed on an
16+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17+
KIND, either express or implied. See the License for the
18+
specific language governing permissions and limitations
19+
under the License.
20+
-->
21+
<section id="add-more-clusters">
22+
<title>Add More Clusters (Optional)</title>
23+
<para>You need to tell &PRODUCT; about the hosts that it will manage. Hosts exist inside clusters,
24+
so before you begin adding hosts to the cloud, you must add at least one cluster.</para>
25+
<xi:include href="about-clusters.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
26+
<xi:include href="add-clusters-kvm-xenserver.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
27+
<xi:include href="add-clusters-ovm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
28+
<xi:include href="add-clusters-vsphere.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
29+
</section>

docs/en-US/add-primary-storage.xml

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<!-- Licensed to the Apache Software Foundation (ASF) under one
7+
or more contributor license agreements. See the NOTICE file
8+
distributed with this work for additional information
9+
regarding copyright ownership. The ASF licenses this file
10+
to you under the Apache License, Version 2.0 (the
11+
"License"); you may not use this file except in compliance
12+
with the License. You may obtain a copy of the License at
13+
http://www.apache.org/licenses/LICENSE-2.0
14+
Unless required by applicable law or agreed to in writing,
15+
software distributed under the License is distributed on an
16+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17+
KIND, either express or implied. See the License for the
18+
specific language governing permissions and limitations
19+
under the License.
20+
-->
21+
<section id="add-primary-storage">
22+
<title>Adding Primary Storage</title>
23+
<note>
24+
<para>Ensure that nothing stored on the server. Adding the server to CloudStack will destroy any
25+
existing data.</para>
26+
</note>
27+
<para>When you create a new zone, the first primary storage is added as part of that procedure.
28+
You can add primary storage servers at any time, such as when adding a new cluster or adding
29+
more servers to an existing cluster.</para>
30+
<orderedlist>
31+
<listitem>
32+
<para>Log in to the &PRODUCT; UI.</para>
33+
</listitem>
34+
<listitem>
35+
<para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the
36+
zone in which you want to add the primary storage.</para>
37+
</listitem>
38+
<listitem>
39+
<para>Click the Compute tab.</para>
40+
</listitem>
41+
<listitem>
42+
<para>In the Primary Storage node of the diagram, click View All.</para>
43+
</listitem>
44+
<listitem>
45+
<para>Click Add Primary Storage.</para>
46+
</listitem>
47+
<listitem>
48+
<para>Provide the following information in the dialog. The information required varies
49+
depending on your choice in Protocol.</para>
50+
<itemizedlist>
51+
<listitem>
52+
<para>Pod. The pod for the storage device.</para>
53+
</listitem>
54+
<listitem>
55+
<para>Cluster. The cluster for the storage device.</para>
56+
</listitem>
57+
<listitem>
58+
<para>Name. The name of the storage device</para>
59+
</listitem>
60+
<listitem>
61+
<para>Protocol. For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS
62+
or SharedMountPoint. For vSphere choose either VMFS (iSCSI or FiberChannel) or
63+
NFS</para>
64+
</listitem>
65+
<listitem>
66+
<para>Server (for NFS, iSCSI, or PreSetup). The IP address or DNS name of the storage
67+
device</para>
68+
</listitem>
69+
<listitem>
70+
<para>Server (for VMFS). The IP address or DNS name of the vCenter server.</para>
71+
</listitem>
72+
<listitem>
73+
<para>Path (for NFS). In NFS this is the exported path from the server.</para>
74+
</listitem>
75+
<listitem>
76+
<para>Path (for VMFS). In vSphere this is a combination of the datacenter name and the
77+
datastore name. The format is "/" datacenter name "/" datastore name. For example,
78+
"/cloud.dc.VM/cluster1datastore".</para>
79+
</listitem>
80+
<listitem>
81+
<para>Path (for SharedMountPoint). With KVM this is the path on each host that is where
82+
this primary storage is mounted. For example, "/mnt/primary".</para>
83+
</listitem>
84+
<listitem>
85+
<para>SR Name-Label (for PreSetup). Enter the name-label of the SR that has been set up
86+
outside &PRODUCT;.</para>
87+
</listitem>
88+
<listitem>
89+
<para>Target IQN (for iSCSI). In iSCSI this is the IQN of the target. For example,
90+
iqn.1986-03.com.sun:02:01ec9bb549-1271378984</para>
91+
</listitem>
92+
<listitem>
93+
<para>Lun # (for iSCSI). In iSCSI this is the LUN number. For example, 3.</para>
94+
</listitem>
95+
<listitem>
96+
<para>Tags (optional). The comma-separated list of tags for this storage device. It should
97+
be an equivalent set or superset of the tags on your disk offerings</para>
98+
</listitem>
99+
</itemizedlist>
100+
<para>The tag sets on primary storage across clusters in a Zone must be identical. For
101+
example, if cluster A provides primary storage that has tags T1 and T2, all other clusters
102+
in the Zone must also provide primary storage that has tags T1 and T2.</para>
103+
</listitem>
104+
<listitem>
105+
<para>Click OK.</para>
106+
</listitem>
107+
</orderedlist>
108+
</section>
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<!-- Licensed to the Apache Software Foundation (ASF) under one
7+
or more contributor license agreements. See the NOTICE file
8+
distributed with this work for additional information
9+
regarding copyright ownership. The ASF licenses this file
10+
to you under the Apache License, Version 2.0 (the
11+
"License"); you may not use this file except in compliance
12+
with the License. You may obtain a copy of the License at
13+
http://www.apache.org/licenses/LICENSE-2.0
14+
Unless required by applicable law or agreed to in writing,
15+
software distributed under the License is distributed on an
16+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17+
KIND, either express or implied. See the License for the
18+
specific language governing permissions and limitations
19+
under the License.
20+
-->
21+
<section id="add-secondary-storage">
22+
<title>Adding Secondary Storage</title>
23+
<note>
24+
<para>Be sure there is nothing stored on the server. Adding the server to CloudStack will
25+
destroy any existing data.</para>
26+
</note>
27+
<para>When you create a new zone, the first secondary storage is added as part of that procedure.
28+
You can add secondary storage servers at any time to add more servers to an existing
29+
zone.</para>
30+
<orderedlist>
31+
<listitem>
32+
<para>If you are going to use Swift for cloud-wide secondary storage, you must add the Swift
33+
storage to &PRODUCT; before you add the local zone secondary storage servers.</para>
34+
</listitem>
35+
<listitem>
36+
<para>To prepare for local zone secondary storage, you should have created and mounted an NFS
37+
share during Management Server installation.</para>
38+
</listitem>
39+
<listitem>
40+
<para>Make sure you prepared the system VM template during Management Server
41+
installation.</para>
42+
</listitem>
43+
<listitem>
44+
<para>4. Now that the secondary storage server for per-zone storage is prepared, add it to
45+
&PRODUCT;. Secondary storage is added as part of the procedure for adding a new zone.</para>
46+
</listitem>
47+
</orderedlist>
48+
</section>
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
2+
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
3+
%BOOK_ENTITIES;
4+
]>
5+
<!-- Licensed to the Apache Software Foundation (ASF) under one
6+
or more contributor license agreements. See the NOTICE file
7+
distributed with this work for additional information
8+
regarding copyright ownership. The ASF licenses this file
9+
to you under the Apache License, Version 2.0 (the
10+
"License"); you may not use this file except in compliance
11+
with the License. You may obtain a copy of the License at
12+
http://www.apache.org/licenses/LICENSE-2.0.
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
-->
20+
21+
<chapter id="choosing_a_deployment_architecture">
22+
<title>Choosing a Deployment Architecture</title>
23+
<para>The architecture used in a deployment will vary depending on the size and purpose of the deployment. This section contains examples of deployment architecture, including a small-scale deployment useful for test and trial deployments and a fully-redundant large-scale setup for production deployments.</para>
24+
<xi:include href="small_scale_deployment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
25+
<xi:include href="large_scale_redundant_setup.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
26+
<xi:include href="separate_storage_network.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
27+
<xi:include href="multi_node_management_server.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
28+
<xi:include href="multi_site_deployment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
29+
</chapter>
Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<!-- Licensed to the Apache Software Foundation (ASF) under one
7+
or more contributor license agreements. See the NOTICE file
8+
distributed with this work for additional information
9+
regarding copyright ownership. The ASF licenses this file
10+
to you under the Apache License, Version 2.0 (the
11+
"License"); you may not use this file except in compliance
12+
with the License. You may obtain a copy of the License at
13+
http://www.apache.org/licenses/LICENSE-2.0
14+
Unless required by applicable law or agreed to in writing,
15+
software distributed under the License is distributed on an
16+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17+
KIND, either express or implied. See the License for the
18+
specific language governing permissions and limitations
19+
under the License.
20+
-->
21+
<section id="create-vpn-connection-vpc">
22+
<title>Creating a VPN Connection</title>
23+
<orderedlist>
24+
<listitem>
25+
<para>Log in to the &PRODUCT; UI as an administrator or end user.</para>
26+
</listitem>
27+
<listitem>
28+
<para>In the left navigation, choose Network.</para>
29+
</listitem>
30+
<listitem>
31+
<para>In the Select view, select VPC.</para>
32+
<para>All the VPCs that you create for the account are listed in the page.</para>
33+
</listitem>
34+
<listitem>
35+
<para>Click the Configure button of the VPC to which you want to deploy the VMs.</para>
36+
<para>The VPC page is displayed where all the tiers you created are listed in a
37+
diagram.</para>
38+
</listitem>
39+
<listitem>
40+
<para>Click the Settings icon.</para>
41+
<para>The following options are displayed.</para>
42+
<itemizedlist>
43+
<listitem>
44+
<para>IP Addresses</para>
45+
</listitem>
46+
<listitem>
47+
<para>Gateways</para>
48+
</listitem>
49+
<listitem>
50+
<para>Site-to-Site VPN</para>
51+
</listitem>
52+
<listitem>
53+
<para>Network ASLs</para>
54+
</listitem>
55+
</itemizedlist>
56+
</listitem>
57+
<listitem>
58+
<para>Select Site-to-Site VPN.</para>
59+
<para>The Site-to-Site VPN page is displayed.</para>
60+
</listitem>
61+
<listitem>
62+
<para>From the Select View drop-down, ensure that VPN Connection is selected.</para>
63+
</listitem>
64+
<listitem>
65+
<para>Click Create VPN Connection.</para>
66+
<para> The Create VPN Connection dialog is displayed:</para>
67+
<mediaobject>
68+
<imageobject>
69+
<imagedata fileref="./images/create-vpn-connection.png"/>
70+
</imageobject>
71+
<textobject>
72+
<phrase>createvpnconnection.png: creating a vpn connection to the customer
73+
gateway.</phrase>
74+
</textobject>
75+
</mediaobject>
76+
</listitem>
77+
<listitem>
78+
<para>Select the desired customer gateway, then click OK to confirm.</para>
79+
<para>Within a few moments, the VPN Connection is displayed.</para>
80+
<para>The following information on the VPN connection is displayed:</para>
81+
<itemizedlist>
82+
<listitem>
83+
<para>IP Address</para>
84+
</listitem>
85+
<listitem>
86+
<para>Gateway</para>
87+
</listitem>
88+
<listitem>
89+
<para>State</para>
90+
</listitem>
91+
<listitem>
92+
<para>IPSec Preshared Key</para>
93+
</listitem>
94+
<listitem>
95+
<para>IKE Policy</para>
96+
</listitem>
97+
<listitem>
98+
<para>ESP Policy</para>
99+
</listitem>
100+
</itemizedlist>
101+
</listitem>
102+
</orderedlist>
103+
</section>

0 commit comments

Comments
 (0)