diff --git a/source/_static/images/B&R-BackupSchedule.png b/source/_static/images/B&R-BackupSchedule.png new file mode 100644 index 0000000000..4c85db14af Binary files /dev/null and b/source/_static/images/B&R-BackupSchedule.png differ diff --git a/source/_static/images/B&R-BackupScheduleEntry.png b/source/_static/images/B&R-BackupScheduleEntry.png new file mode 100644 index 0000000000..3f5b3392ae Binary files /dev/null and b/source/_static/images/B&R-BackupScheduleEntry.png differ diff --git a/source/_static/images/B&R-assignOffering.png b/source/_static/images/B&R-assignOffering.png new file mode 100644 index 0000000000..59fc9ffdad Binary files /dev/null and b/source/_static/images/B&R-assignOffering.png differ diff --git a/source/_static/images/B&R-backup_offering.png b/source/_static/images/B&R-backup_offering.png new file mode 100644 index 0000000000..e33f5da936 Binary files /dev/null and b/source/_static/images/B&R-backup_offering.png differ diff --git a/source/_static/images/B&R-backup_offering_policy.png b/source/_static/images/B&R-backup_offering_policy.png new file mode 100644 index 0000000000..4e9ecc459a Binary files /dev/null and b/source/_static/images/B&R-backup_offering_policy.png differ diff --git a/source/_static/images/B&R-createBackup.png b/source/_static/images/B&R-createBackup.png new file mode 100644 index 0000000000..199e5d9f98 Binary files /dev/null and b/source/_static/images/B&R-createBackup.png differ diff --git a/source/_static/images/CloudStack-ldap-screen1.png b/source/_static/images/CloudStack-ldap-screen1.png index 46032a4b7a..64ae3b799f 100644 Binary files a/source/_static/images/CloudStack-ldap-screen1.png and b/source/_static/images/CloudStack-ldap-screen1.png differ diff --git a/source/_static/images/L2-networks-gui.png b/source/_static/images/L2-networks-gui.png new file mode 100644 index 0000000000..c503fde85e Binary files /dev/null and b/source/_static/images/L2-networks-gui.png differ diff --git a/source/_static/images/SnapshotButton.png b/source/_static/images/SnapshotButton.png index 5217740219..02c406abc5 100644 Binary files a/source/_static/images/SnapshotButton.png and b/source/_static/images/SnapshotButton.png differ diff --git a/source/_static/images/VMSnapshotButton.png b/source/_static/images/VMSnapshotButton.png index 5217740219..27fa229a10 100644 Binary files a/source/_static/images/VMSnapshotButton.png and b/source/_static/images/VMSnapshotButton.png differ diff --git a/source/_static/images/add-cluster.png b/source/_static/images/add-cluster.png index 4b24ec721d..79c1728270 100644 Binary files a/source/_static/images/add-cluster.png and b/source/_static/images/add-cluster.png differ diff --git a/source/_static/images/add-guest-network.png b/source/_static/images/add-guest-network.png index 5740ab58d3..28fd769c6a 100644 Binary files a/source/_static/images/add-guest-network.png and b/source/_static/images/add-guest-network.png differ diff --git a/source/_static/images/add-ip-range.png b/source/_static/images/add-ip-range.png index 9f4d9d48ef..3bc4dbbb25 100644 Binary files a/source/_static/images/add-ip-range.png and b/source/_static/images/add-ip-range.png differ diff --git a/source/_static/images/add-new-gateway-vpc.png b/source/_static/images/add-new-gateway-vpc.png index 5145622a2f..8e26579b26 100644 Binary files a/source/_static/images/add-new-gateway-vpc.png and b/source/_static/images/add-new-gateway-vpc.png differ diff --git a/source/_static/images/add-tier.png b/source/_static/images/add-tier.png index 0994dbd0a5..94b0661027 100644 Binary files a/source/_static/images/add-tier.png and b/source/_static/images/add-tier.png differ diff --git a/source/_static/images/add-vm-vpc.png b/source/_static/images/add-vm-vpc.png index b2821a6915..872ad398c6 100644 Binary files a/source/_static/images/add-vm-vpc.png and b/source/_static/images/add-vm-vpc.png differ diff --git a/source/_static/images/add-vpc.png b/source/_static/images/add-vpc.png index f334862341..c2a07ed287 100644 Binary files a/source/_static/images/add-vpc.png and b/source/_static/images/add-vpc.png differ diff --git a/source/_static/images/add-vpn-customer-gateway.png b/source/_static/images/add-vpn-customer-gateway.png index fdc3177e9e..bae63f8c5e 100644 Binary files a/source/_static/images/add-vpn-customer-gateway.png and b/source/_static/images/add-vpn-customer-gateway.png differ diff --git a/source/_static/images/addAccount-icon.png b/source/_static/images/addAccount-icon.png index 4743dbef2c..91601713f3 100644 Binary files a/source/_static/images/addAccount-icon.png and b/source/_static/images/addAccount-icon.png differ diff --git a/source/_static/images/addvm-tier-sharednw.png b/source/_static/images/addvm-tier-sharednw.png index e60205f721..20f3c09187 100644 Binary files a/source/_static/images/addvm-tier-sharednw.png and b/source/_static/images/addvm-tier-sharednw.png differ diff --git a/source/_static/images/attach-disk-icon.png b/source/_static/images/attach-disk-icon.png index 5e81d04fda..2c7e622ff2 100644 Binary files a/source/_static/images/attach-disk-icon.png and b/source/_static/images/attach-disk-icon.png differ diff --git a/source/_static/images/change-affinity-button.png b/source/_static/images/change-affinity-button.png index c21ef758dc..91da3070f6 100644 Binary files a/source/_static/images/change-affinity-button.png and b/source/_static/images/change-affinity-button.png differ diff --git a/source/_static/images/change-password.png b/source/_static/images/change-password.png index fbb203a5e2..4c2fac4d53 100644 Binary files a/source/_static/images/change-password.png and b/source/_static/images/change-password.png differ diff --git a/source/_static/images/change-service-icon.png b/source/_static/images/change-service-icon.png index 780e235f2f..eb99d1ffdd 100644 Binary files a/source/_static/images/change-service-icon.png and b/source/_static/images/change-service-icon.png differ diff --git a/source/_static/images/cks-add-version-form.png b/source/_static/images/cks-add-version-form.png index 317a0aab30..3efeb0fed9 100644 Binary files a/source/_static/images/cks-add-version-form.png and b/source/_static/images/cks-add-version-form.png differ diff --git a/source/_static/images/cks-cluster-access-tab.png b/source/_static/images/cks-cluster-access-tab.png index 6e3bc33e9e..7da6b8f904 100644 Binary files a/source/_static/images/cks-cluster-access-tab.png and b/source/_static/images/cks-cluster-access-tab.png differ diff --git a/source/_static/images/cks-cluster-details-tab.png b/source/_static/images/cks-cluster-details-tab.png index be41217e04..df5afa5878 100644 Binary files a/source/_static/images/cks-cluster-details-tab.png and b/source/_static/images/cks-cluster-details-tab.png differ diff --git a/source/_static/images/cks-clusters.png b/source/_static/images/cks-clusters.png index 5b0705168f..54fdcb44be 100644 Binary files a/source/_static/images/cks-clusters.png and b/source/_static/images/cks-clusters.png differ diff --git a/source/_static/images/cks-create-cluster-form.png b/source/_static/images/cks-create-cluster-form.png index 6e4ad4aa1b..84ca28a4f2 100644 Binary files a/source/_static/images/cks-create-cluster-form.png and b/source/_static/images/cks-create-cluster-form.png differ diff --git a/source/_static/images/cks-delete-action.png b/source/_static/images/cks-delete-action.png index ce2b0aaf97..60b5e3982b 100644 Binary files a/source/_static/images/cks-delete-action.png and b/source/_static/images/cks-delete-action.png differ diff --git a/source/_static/images/cks-kube-config-action.png b/source/_static/images/cks-kube-config-action.png index b06adc33ad..d8777d0dbf 100644 Binary files a/source/_static/images/cks-kube-config-action.png and b/source/_static/images/cks-kube-config-action.png differ diff --git a/source/_static/images/cks-scale-action.png b/source/_static/images/cks-scale-action.png index c060695b6c..91da3070f6 100644 Binary files a/source/_static/images/cks-scale-action.png and b/source/_static/images/cks-scale-action.png differ diff --git a/source/_static/images/cks-scale-cluster-form.png b/source/_static/images/cks-scale-cluster-form.png index 0ea9655c3f..54539063fa 100644 Binary files a/source/_static/images/cks-scale-cluster-form.png and b/source/_static/images/cks-scale-cluster-form.png differ diff --git a/source/_static/images/cks-start-action.png b/source/_static/images/cks-start-action.png index 913f5667d0..310040ca8d 100644 Binary files a/source/_static/images/cks-start-action.png and b/source/_static/images/cks-start-action.png differ diff --git a/source/_static/images/cks-stop-action.png b/source/_static/images/cks-stop-action.png index 69d31638ea..cfebb8ec09 100644 Binary files a/source/_static/images/cks-stop-action.png and b/source/_static/images/cks-stop-action.png differ diff --git a/source/_static/images/cks-upgrade-action.png b/source/_static/images/cks-upgrade-action.png index 1a1e82af3e..ae9fb2a50e 100644 Binary files a/source/_static/images/cks-upgrade-action.png and b/source/_static/images/cks-upgrade-action.png differ diff --git a/source/_static/images/cks-upgrade-cluster-form.png b/source/_static/images/cks-upgrade-cluster-form.png index 6ee97dc860..79fed82c01 100644 Binary files a/source/_static/images/cks-upgrade-cluster-form.png and b/source/_static/images/cks-upgrade-cluster-form.png differ diff --git a/source/_static/images/cks-versions.png b/source/_static/images/cks-versions.png index d219e1635d..fb4dc29c36 100644 Binary files a/source/_static/images/cks-versions.png and b/source/_static/images/cks-versions.png differ diff --git a/source/_static/images/cloudian-s3_ss_cache.png b/source/_static/images/cloudian-s3_ss_cache.png index 5d97186ffc..ef5ebdeca6 100644 Binary files a/source/_static/images/cloudian-s3_ss_cache.png and b/source/_static/images/cloudian-s3_ss_cache.png differ diff --git a/source/_static/images/cloudian-ss_globalopt.png b/source/_static/images/cloudian-ss_globalopt.png index d1b9272694..8925d57f8c 100644 Binary files a/source/_static/images/cloudian-ss_globalopt.png and b/source/_static/images/cloudian-ss_globalopt.png differ diff --git a/source/_static/images/compute-service-offerings.png b/source/_static/images/compute-service-offerings.png index 88eb6f8059..c8de8be6a8 100644 Binary files a/source/_static/images/compute-service-offerings.png and b/source/_static/images/compute-service-offerings.png differ diff --git a/source/_static/images/compute_offering_dialog.png b/source/_static/images/compute_offering_dialog.png index 210cb8dfff..401796513a 100644 Binary files a/source/_static/images/compute_offering_dialog.png and b/source/_static/images/compute_offering_dialog.png differ diff --git a/source/_static/images/console-icon.png b/source/_static/images/console-icon.png index bf28886974..a43676ae09 100644 Binary files a/source/_static/images/console-icon.png and b/source/_static/images/console-icon.png differ diff --git a/source/_static/images/create-vpn-connection.png b/source/_static/images/create-vpn-connection.png index c7d8c15f9d..0d2caf1221 100644 Binary files a/source/_static/images/create-vpn-connection.png and b/source/_static/images/create-vpn-connection.png differ diff --git a/source/_static/images/dedicate-resource-button.png b/source/_static/images/dedicate-resource-button.png index 0ac38e00ec..3bba183135 100644 Binary files a/source/_static/images/dedicate-resource-button.png and b/source/_static/images/dedicate-resource-button.png differ diff --git a/source/_static/images/del-tier.png b/source/_static/images/del-tier.png index aa9846cfd9..60b5e3982b 100644 Binary files a/source/_static/images/del-tier.png and b/source/_static/images/del-tier.png differ diff --git a/source/_static/images/delete-button.png b/source/_static/images/delete-button.png index 27145cebbc..60b5e3982b 100644 Binary files a/source/_static/images/delete-button.png and b/source/_static/images/delete-button.png differ diff --git a/source/_static/images/destroy-instance.png b/source/_static/images/destroy-instance.png index aa9846cfd9..60b5e3982b 100644 Binary files a/source/_static/images/destroy-instance.png and b/source/_static/images/destroy-instance.png differ diff --git a/source/_static/images/detach-disk-icon.png b/source/_static/images/detach-disk-icon.png index 536a4f8d00..00e2d43e55 100644 Binary files a/source/_static/images/detach-disk-icon.png and b/source/_static/images/detach-disk-icon.png differ diff --git a/source/_static/images/diagnostics-form.png b/source/_static/images/diagnostics-form.png index a9b0b37c7f..31c474d61c 100644 Binary files a/source/_static/images/diagnostics-form.png and b/source/_static/images/diagnostics-form.png differ diff --git a/source/_static/images/ec2-s3-configuration.png b/source/_static/images/ec2-s3-configuration.png index e9f98f0f21..c42441ef42 100644 Binary files a/source/_static/images/ec2-s3-configuration.png and b/source/_static/images/ec2-s3-configuration.png differ diff --git a/source/_static/images/edit-icon.png b/source/_static/images/edit-icon.png index 42417e278d..5e3d53baf6 100644 Binary files a/source/_static/images/edit-icon.png and b/source/_static/images/edit-icon.png differ diff --git a/source/_static/images/egress-firewall-rule.png b/source/_static/images/egress-firewall-rule.png index fa1d8ecd0b..55f0684619 100644 Binary files a/source/_static/images/egress-firewall-rule.png and b/source/_static/images/egress-firewall-rule.png differ diff --git a/source/_static/images/enable-disable.png b/source/_static/images/enable-disable.png index cab31ae3d5..d8eccd6e88 100644 Binary files a/source/_static/images/enable-disable.png and b/source/_static/images/enable-disable.png differ diff --git a/source/_static/images/http-access.png b/source/_static/images/http-access.png index 817f197985..6f4e0bc122 100644 Binary files a/source/_static/images/http-access.png and b/source/_static/images/http-access.png differ diff --git a/source/_static/images/iso-icon.png b/source/_static/images/iso-icon.png index 8d547fb397..2c7e622ff2 100644 Binary files a/source/_static/images/iso-icon.png and b/source/_static/images/iso-icon.png differ diff --git a/source/_static/images/kvm-direct-download.png b/source/_static/images/kvm-direct-download.png index d29dab61ba..68d4097d8c 100644 Binary files a/source/_static/images/kvm-direct-download.png and b/source/_static/images/kvm-direct-download.png differ diff --git a/source/_static/images/kvm-rolling-maintenance.png b/source/_static/images/kvm-rolling-maintenance.png index ce05eb22d3..fbb1191dbc 100644 Binary files a/source/_static/images/kvm-rolling-maintenance.png and b/source/_static/images/kvm-rolling-maintenance.png differ diff --git a/source/_static/images/1000-foot-view.png b/source/_static/images/legacy/1000-foot-view.png similarity index 100% rename from source/_static/images/1000-foot-view.png rename to source/_static/images/legacy/1000-foot-view.png diff --git a/source/_static/images/B&R-BackupSchedule.jpg b/source/_static/images/legacy/B&R-BackupSchedule.jpg similarity index 100% rename from source/_static/images/B&R-BackupSchedule.jpg rename to source/_static/images/legacy/B&R-BackupSchedule.jpg diff --git a/source/_static/images/B&R-BackupScheduleEntry.jpg b/source/_static/images/legacy/B&R-BackupScheduleEntry.jpg similarity index 100% rename from source/_static/images/B&R-BackupScheduleEntry.jpg rename to source/_static/images/legacy/B&R-BackupScheduleEntry.jpg diff --git a/source/_static/images/B&R-assignOffering.jpg b/source/_static/images/legacy/B&R-assignOffering.jpg similarity index 100% rename from source/_static/images/B&R-assignOffering.jpg rename to source/_static/images/legacy/B&R-assignOffering.jpg diff --git a/source/_static/images/B&R-backup_offering.jpg b/source/_static/images/legacy/B&R-backup_offering.jpg similarity index 100% rename from source/_static/images/B&R-backup_offering.jpg rename to source/_static/images/legacy/B&R-backup_offering.jpg diff --git a/source/_static/images/B&R-backup_offering_policy.jpg b/source/_static/images/legacy/B&R-backup_offering_policy.jpg similarity index 100% rename from source/_static/images/B&R-backup_offering_policy.jpg rename to source/_static/images/legacy/B&R-backup_offering_policy.jpg diff --git a/source/_static/images/B&R-createBackup.jpg b/source/_static/images/legacy/B&R-createBackup.jpg similarity index 100% rename from source/_static/images/B&R-createBackup.jpg rename to source/_static/images/legacy/B&R-createBackup.jpg diff --git a/source/_static/images/legacy/CloudStack-ldap-screen1.png b/source/_static/images/legacy/CloudStack-ldap-screen1.png new file mode 100644 index 0000000000..46032a4b7a Binary files /dev/null and b/source/_static/images/legacy/CloudStack-ldap-screen1.png differ diff --git a/source/_static/images/DevCloud-hostonly.png b/source/_static/images/legacy/DevCloud-hostonly.png similarity index 100% rename from source/_static/images/DevCloud-hostonly.png rename to source/_static/images/legacy/DevCloud-hostonly.png diff --git a/source/_static/images/DevCloud.png b/source/_static/images/legacy/DevCloud.png similarity index 100% rename from source/_static/images/DevCloud.png rename to source/_static/images/legacy/DevCloud.png diff --git a/source/_static/images/L2-networks-gui.JPG b/source/_static/images/legacy/L2-networks-gui.JPG similarity index 100% rename from source/_static/images/L2-networks-gui.JPG rename to source/_static/images/legacy/L2-networks-gui.JPG diff --git a/source/_static/images/legacy/SnapshotButton.png b/source/_static/images/legacy/SnapshotButton.png new file mode 100644 index 0000000000..5217740219 Binary files /dev/null and b/source/_static/images/legacy/SnapshotButton.png differ diff --git a/source/_static/images/legacy/VMSnapshotButton.png b/source/_static/images/legacy/VMSnapshotButton.png new file mode 100644 index 0000000000..5217740219 Binary files /dev/null and b/source/_static/images/legacy/VMSnapshotButton.png differ diff --git a/source/_static/images/about-cloudstack-customized.JPG b/source/_static/images/legacy/about-cloudstack-customized.JPG similarity index 100% rename from source/_static/images/about-cloudstack-customized.JPG rename to source/_static/images/legacy/about-cloudstack-customized.JPG diff --git a/source/_static/images/add-cifs.png b/source/_static/images/legacy/add-cifs.png similarity index 100% rename from source/_static/images/add-cifs.png rename to source/_static/images/legacy/add-cifs.png diff --git a/source/_static/images/legacy/add-cluster.png b/source/_static/images/legacy/add-cluster.png new file mode 100644 index 0000000000..4b24ec721d Binary files /dev/null and b/source/_static/images/legacy/add-cluster.png differ diff --git a/source/_static/images/add-gateway.png b/source/_static/images/legacy/add-gateway.png similarity index 100% rename from source/_static/images/add-gateway.png rename to source/_static/images/legacy/add-gateway.png diff --git a/source/_static/images/legacy/add-guest-network.png b/source/_static/images/legacy/add-guest-network.png new file mode 100644 index 0000000000..5740ab58d3 Binary files /dev/null and b/source/_static/images/legacy/add-guest-network.png differ diff --git a/source/_static/images/add-instance-keyboards-customized.JPG b/source/_static/images/legacy/add-instance-keyboards-customized.JPG similarity index 100% rename from source/_static/images/add-instance-keyboards-customized.JPG rename to source/_static/images/legacy/add-instance-keyboards-customized.JPG diff --git a/source/_static/images/legacy/add-ip-range.png b/source/_static/images/legacy/add-ip-range.png new file mode 100644 index 0000000000..9f4d9d48ef Binary files /dev/null and b/source/_static/images/legacy/add-ip-range.png differ diff --git a/source/_static/images/add-ldap-configuration-ad.png b/source/_static/images/legacy/add-ldap-configuration-ad.png similarity index 100% rename from source/_static/images/add-ldap-configuration-ad.png rename to source/_static/images/legacy/add-ldap-configuration-ad.png diff --git a/source/_static/images/add-ldap-configuration-openldap.png b/source/_static/images/legacy/add-ldap-configuration-openldap.png similarity index 100% rename from source/_static/images/add-ldap-configuration-openldap.png rename to source/_static/images/legacy/add-ldap-configuration-openldap.png diff --git a/source/_static/images/legacy/add-new-gateway-vpc.png b/source/_static/images/legacy/add-new-gateway-vpc.png new file mode 100644 index 0000000000..5145622a2f Binary files /dev/null and b/source/_static/images/legacy/add-new-gateway-vpc.png differ diff --git a/source/_static/images/legacy/add-tier.png b/source/_static/images/legacy/add-tier.png new file mode 100644 index 0000000000..0994dbd0a5 Binary files /dev/null and b/source/_static/images/legacy/add-tier.png differ diff --git a/source/_static/images/add-vlan-icon.png b/source/_static/images/legacy/add-vlan-icon.png similarity index 100% rename from source/_static/images/add-vlan-icon.png rename to source/_static/images/legacy/add-vlan-icon.png diff --git a/source/_static/images/legacy/add-vm-vpc.png b/source/_static/images/legacy/add-vm-vpc.png new file mode 100644 index 0000000000..b2821a6915 Binary files /dev/null and b/source/_static/images/legacy/add-vm-vpc.png differ diff --git a/source/_static/images/legacy/add-vpc.png b/source/_static/images/legacy/add-vpc.png new file mode 100644 index 0000000000..f334862341 Binary files /dev/null and b/source/_static/images/legacy/add-vpc.png differ diff --git a/source/_static/images/legacy/add-vpn-customer-gateway.png b/source/_static/images/legacy/add-vpn-customer-gateway.png new file mode 100644 index 0000000000..fdc3177e9e Binary files /dev/null and b/source/_static/images/legacy/add-vpn-customer-gateway.png differ diff --git a/source/_static/images/legacy/addAccount-icon.png b/source/_static/images/legacy/addAccount-icon.png new file mode 100644 index 0000000000..4743dbef2c Binary files /dev/null and b/source/_static/images/legacy/addAccount-icon.png differ diff --git a/source/_static/images/legacy/addvm-tier-sharednw.png b/source/_static/images/legacy/addvm-tier-sharednw.png new file mode 100644 index 0000000000..e60205f721 Binary files /dev/null and b/source/_static/images/legacy/addvm-tier-sharednw.png differ diff --git a/source/_static/images/legacy/attach-disk-icon.png b/source/_static/images/legacy/attach-disk-icon.png new file mode 100644 index 0000000000..5e81d04fda Binary files /dev/null and b/source/_static/images/legacy/attach-disk-icon.png differ diff --git a/source/_static/images/legacy/change-affinity-button.png b/source/_static/images/legacy/change-affinity-button.png new file mode 100644 index 0000000000..c21ef758dc Binary files /dev/null and b/source/_static/images/legacy/change-affinity-button.png differ diff --git a/source/_static/images/legacy/change-password.png b/source/_static/images/legacy/change-password.png new file mode 100644 index 0000000000..fbb203a5e2 Binary files /dev/null and b/source/_static/images/legacy/change-password.png differ diff --git a/source/_static/images/legacy/change-service-icon.png b/source/_static/images/legacy/change-service-icon.png new file mode 100644 index 0000000000..780e235f2f Binary files /dev/null and b/source/_static/images/legacy/change-service-icon.png differ diff --git a/source/_static/images/cifs-primary.png b/source/_static/images/legacy/cifs-primary.png similarity index 100% rename from source/_static/images/cifs-primary.png rename to source/_static/images/legacy/cifs-primary.png diff --git a/source/_static/images/cifs-ss.png b/source/_static/images/legacy/cifs-ss.png similarity index 100% rename from source/_static/images/cifs-ss.png rename to source/_static/images/legacy/cifs-ss.png diff --git a/source/_static/images/legacy/cks-add-version-form.png b/source/_static/images/legacy/cks-add-version-form.png new file mode 100644 index 0000000000..317a0aab30 Binary files /dev/null and b/source/_static/images/legacy/cks-add-version-form.png differ diff --git a/source/_static/images/legacy/cks-cluster-access-tab.png b/source/_static/images/legacy/cks-cluster-access-tab.png new file mode 100644 index 0000000000..6e3bc33e9e Binary files /dev/null and b/source/_static/images/legacy/cks-cluster-access-tab.png differ diff --git a/source/_static/images/legacy/cks-cluster-details-tab.png b/source/_static/images/legacy/cks-cluster-details-tab.png new file mode 100644 index 0000000000..be41217e04 Binary files /dev/null and b/source/_static/images/legacy/cks-cluster-details-tab.png differ diff --git a/source/_static/images/legacy/cks-clusters.png b/source/_static/images/legacy/cks-clusters.png new file mode 100644 index 0000000000..5b0705168f Binary files /dev/null and b/source/_static/images/legacy/cks-clusters.png differ diff --git a/source/_static/images/legacy/cks-create-cluster-form.png b/source/_static/images/legacy/cks-create-cluster-form.png new file mode 100644 index 0000000000..6e4ad4aa1b Binary files /dev/null and b/source/_static/images/legacy/cks-create-cluster-form.png differ diff --git a/source/_static/images/legacy/cks-delete-action.png b/source/_static/images/legacy/cks-delete-action.png new file mode 100644 index 0000000000..ce2b0aaf97 Binary files /dev/null and b/source/_static/images/legacy/cks-delete-action.png differ diff --git a/source/_static/images/legacy/cks-kube-config-action.png b/source/_static/images/legacy/cks-kube-config-action.png new file mode 100644 index 0000000000..b06adc33ad Binary files /dev/null and b/source/_static/images/legacy/cks-kube-config-action.png differ diff --git a/source/_static/images/legacy/cks-scale-action.png b/source/_static/images/legacy/cks-scale-action.png new file mode 100644 index 0000000000..c060695b6c Binary files /dev/null and b/source/_static/images/legacy/cks-scale-action.png differ diff --git a/source/_static/images/legacy/cks-scale-cluster-form.png b/source/_static/images/legacy/cks-scale-cluster-form.png new file mode 100644 index 0000000000..0ea9655c3f Binary files /dev/null and b/source/_static/images/legacy/cks-scale-cluster-form.png differ diff --git a/source/_static/images/legacy/cks-start-action.png b/source/_static/images/legacy/cks-start-action.png new file mode 100644 index 0000000000..913f5667d0 Binary files /dev/null and b/source/_static/images/legacy/cks-start-action.png differ diff --git a/source/_static/images/legacy/cks-stop-action.png b/source/_static/images/legacy/cks-stop-action.png new file mode 100644 index 0000000000..69d31638ea Binary files /dev/null and b/source/_static/images/legacy/cks-stop-action.png differ diff --git a/source/_static/images/legacy/cks-upgrade-action.png b/source/_static/images/legacy/cks-upgrade-action.png new file mode 100644 index 0000000000..1a1e82af3e Binary files /dev/null and b/source/_static/images/legacy/cks-upgrade-action.png differ diff --git a/source/_static/images/legacy/cks-upgrade-cluster-form.png b/source/_static/images/legacy/cks-upgrade-cluster-form.png new file mode 100644 index 0000000000..6ee97dc860 Binary files /dev/null and b/source/_static/images/legacy/cks-upgrade-cluster-form.png differ diff --git a/source/_static/images/legacy/cks-versions.png b/source/_static/images/legacy/cks-versions.png new file mode 100644 index 0000000000..d219e1635d Binary files /dev/null and b/source/_static/images/legacy/cks-versions.png differ diff --git a/source/_static/images/legacy/cloudian-s3_ss_cache.png b/source/_static/images/legacy/cloudian-s3_ss_cache.png new file mode 100644 index 0000000000..5d97186ffc Binary files /dev/null and b/source/_static/images/legacy/cloudian-s3_ss_cache.png differ diff --git a/source/_static/images/legacy/cloudian-ss_globalopt.png b/source/_static/images/legacy/cloudian-ss_globalopt.png new file mode 100644 index 0000000000..d1b9272694 Binary files /dev/null and b/source/_static/images/legacy/cloudian-ss_globalopt.png differ diff --git a/source/_static/images/legacy/compute-service-offerings.png b/source/_static/images/legacy/compute-service-offerings.png new file mode 100644 index 0000000000..88eb6f8059 Binary files /dev/null and b/source/_static/images/legacy/compute-service-offerings.png differ diff --git a/source/_static/images/compute_offering_dialog-multidomain.png b/source/_static/images/legacy/compute_offering_dialog-multidomain.png similarity index 100% rename from source/_static/images/compute_offering_dialog-multidomain.png rename to source/_static/images/legacy/compute_offering_dialog-multidomain.png diff --git a/source/_static/images/legacy/compute_offering_dialog.png b/source/_static/images/legacy/compute_offering_dialog.png new file mode 100644 index 0000000000..210cb8dfff Binary files /dev/null and b/source/_static/images/legacy/compute_offering_dialog.png differ diff --git a/source/_static/images/legacy/console-icon.png b/source/_static/images/legacy/console-icon.png new file mode 100644 index 0000000000..bf28886974 Binary files /dev/null and b/source/_static/images/legacy/console-icon.png differ diff --git a/source/_static/images/legacy/create-vpn-connection.png b/source/_static/images/legacy/create-vpn-connection.png new file mode 100644 index 0000000000..c7d8c15f9d Binary files /dev/null and b/source/_static/images/legacy/create-vpn-connection.png differ diff --git a/source/_static/images/legacy/dedicate-resource-button.png b/source/_static/images/legacy/dedicate-resource-button.png new file mode 100644 index 0000000000..0ac38e00ec Binary files /dev/null and b/source/_static/images/legacy/dedicate-resource-button.png differ diff --git a/source/_static/images/legacy/del-tier.png b/source/_static/images/legacy/del-tier.png new file mode 100644 index 0000000000..aa9846cfd9 Binary files /dev/null and b/source/_static/images/legacy/del-tier.png differ diff --git a/source/_static/images/legacy/delete-button.png b/source/_static/images/legacy/delete-button.png new file mode 100644 index 0000000000..27145cebbc Binary files /dev/null and b/source/_static/images/legacy/delete-button.png differ diff --git a/source/_static/images/legacy/destroy-instance.png b/source/_static/images/legacy/destroy-instance.png new file mode 100644 index 0000000000..aa9846cfd9 Binary files /dev/null and b/source/_static/images/legacy/destroy-instance.png differ diff --git a/source/_static/images/legacy/detach-disk-icon.png b/source/_static/images/legacy/detach-disk-icon.png new file mode 100644 index 0000000000..536a4f8d00 Binary files /dev/null and b/source/_static/images/legacy/detach-disk-icon.png differ diff --git a/source/_static/images/legacy/diagnostics-form.png b/source/_static/images/legacy/diagnostics-form.png new file mode 100644 index 0000000000..a9b0b37c7f Binary files /dev/null and b/source/_static/images/legacy/diagnostics-form.png differ diff --git a/source/_static/images/dvswitch-config.png b/source/_static/images/legacy/dvswitch-config.png similarity index 100% rename from source/_static/images/dvswitch-config.png rename to source/_static/images/legacy/dvswitch-config.png diff --git a/source/_static/images/legacy/ec2-s3-configuration.png b/source/_static/images/legacy/ec2-s3-configuration.png new file mode 100644 index 0000000000..e9f98f0f21 Binary files /dev/null and b/source/_static/images/legacy/ec2-s3-configuration.png differ diff --git a/source/_static/images/legacy/edit-icon.png b/source/_static/images/legacy/edit-icon.png new file mode 100644 index 0000000000..42417e278d Binary files /dev/null and b/source/_static/images/legacy/edit-icon.png differ diff --git a/source/_static/images/edit-traffic-type.png b/source/_static/images/legacy/edit-traffic-type.png similarity index 100% rename from source/_static/images/edit-traffic-type.png rename to source/_static/images/legacy/edit-traffic-type.png diff --git a/source/_static/images/legacy/egress-firewall-rule.png b/source/_static/images/legacy/egress-firewall-rule.png new file mode 100644 index 0000000000..fa1d8ecd0b Binary files /dev/null and b/source/_static/images/legacy/egress-firewall-rule.png differ diff --git a/source/_static/images/legacy/enable-disable.png b/source/_static/images/legacy/enable-disable.png new file mode 100644 index 0000000000..cab31ae3d5 Binary files /dev/null and b/source/_static/images/legacy/enable-disable.png differ diff --git a/source/_static/images/legacy/http-access.png b/source/_static/images/legacy/http-access.png new file mode 100644 index 0000000000..817f197985 Binary files /dev/null and b/source/_static/images/legacy/http-access.png differ diff --git a/source/_static/images/instance-metrics-customized-view.JPG b/source/_static/images/legacy/instance-metrics-customized-view.JPG similarity index 100% rename from source/_static/images/instance-metrics-customized-view.JPG rename to source/_static/images/legacy/instance-metrics-customized-view.JPG diff --git a/source/_static/images/legacy/iso-icon.png b/source/_static/images/legacy/iso-icon.png new file mode 100644 index 0000000000..8d547fb397 Binary files /dev/null and b/source/_static/images/legacy/iso-icon.png differ diff --git a/source/_static/images/legacy/kvm-direct-download.png b/source/_static/images/legacy/kvm-direct-download.png new file mode 100644 index 0000000000..d29dab61ba Binary files /dev/null and b/source/_static/images/legacy/kvm-direct-download.png differ diff --git a/source/_static/images/legacy/kvm-rolling-maintenance.png b/source/_static/images/legacy/kvm-rolling-maintenance.png new file mode 100644 index 0000000000..ce05eb22d3 Binary files /dev/null and b/source/_static/images/legacy/kvm-rolling-maintenance.png differ diff --git a/source/_static/images/ldap-config.png b/source/_static/images/legacy/ldap-config.png similarity index 100% rename from source/_static/images/ldap-config.png rename to source/_static/images/legacy/ldap-config.png diff --git a/source/_static/images/mesos-integration-arch.jpg b/source/_static/images/legacy/mesos-integration-arch.jpg similarity index 100% rename from source/_static/images/mesos-integration-arch.jpg rename to source/_static/images/legacy/mesos-integration-arch.jpg diff --git a/source/_static/images/metric-view.png b/source/_static/images/legacy/metric-view.png similarity index 100% rename from source/_static/images/metric-view.png rename to source/_static/images/legacy/metric-view.png diff --git a/source/_static/images/legacy/migrate-instance.png b/source/_static/images/legacy/migrate-instance.png new file mode 100644 index 0000000000..25ff57245b Binary files /dev/null and b/source/_static/images/legacy/migrate-instance.png differ diff --git a/source/_static/images/network-acl.png b/source/_static/images/legacy/network-acl.png similarity index 100% rename from source/_static/images/network-acl.png rename to source/_static/images/legacy/network-acl.png diff --git a/source/_static/images/legacy/networking-egress-rule.png b/source/_static/images/legacy/networking-egress-rule.png new file mode 100644 index 0000000000..edf1f6d885 Binary files /dev/null and b/source/_static/images/legacy/networking-egress-rule.png differ diff --git a/source/_static/images/networking-in-a-pod.png b/source/_static/images/legacy/networking-in-a-pod.png similarity index 100% rename from source/_static/images/networking-in-a-pod.png rename to source/_static/images/legacy/networking-in-a-pod.png diff --git a/source/_static/images/networking-in-a-zone.png b/source/_static/images/legacy/networking-in-a-zone.png similarity index 100% rename from source/_static/images/networking-in-a-zone.png rename to source/_static/images/legacy/networking-in-a-zone.png diff --git a/source/_static/images/legacy/networking-infra-traffic-labels.png b/source/_static/images/legacy/networking-infra-traffic-labels.png new file mode 100644 index 0000000000..e029d7dd85 Binary files /dev/null and b/source/_static/images/legacy/networking-infra-traffic-labels.png differ diff --git a/source/_static/images/legacy/networking-ingress-rule.png b/source/_static/images/legacy/networking-ingress-rule.png new file mode 100644 index 0000000000..8b1af227f1 Binary files /dev/null and b/source/_static/images/legacy/networking-ingress-rule.png differ diff --git a/source/_static/images/legacy/networking-zone-traffic-labels.png b/source/_static/images/legacy/networking-zone-traffic-labels.png new file mode 100644 index 0000000000..1587c2b6e5 Binary files /dev/null and b/source/_static/images/legacy/networking-zone-traffic-labels.png differ diff --git a/source/_static/images/legacy/nvp-add-controller.png b/source/_static/images/legacy/nvp-add-controller.png new file mode 100644 index 0000000000..e02d31f0a3 Binary files /dev/null and b/source/_static/images/legacy/nvp-add-controller.png differ diff --git a/source/_static/images/legacy/nvp-enable-provider.png b/source/_static/images/legacy/nvp-enable-provider.png new file mode 100644 index 0000000000..0f2d02ddfa Binary files /dev/null and b/source/_static/images/legacy/nvp-enable-provider.png differ diff --git a/source/_static/images/legacy/nvp-network-offering.png b/source/_static/images/legacy/nvp-network-offering.png new file mode 100644 index 0000000000..c2d25c48c1 Binary files /dev/null and b/source/_static/images/legacy/nvp-network-offering.png differ diff --git a/source/_static/images/legacy/nvp-physical-network-stt.png b/source/_static/images/legacy/nvp-physical-network-stt.png new file mode 100644 index 0000000000..2ce7853ac5 Binary files /dev/null and b/source/_static/images/legacy/nvp-physical-network-stt.png differ diff --git a/source/_static/images/legacy/ovs-network-offering.png b/source/_static/images/legacy/ovs-network-offering.png new file mode 100644 index 0000000000..750c5f09b1 Binary files /dev/null and b/source/_static/images/legacy/ovs-network-offering.png differ diff --git a/source/_static/images/legacy/ovs-physical-network-gre-enable.png b/source/_static/images/legacy/ovs-physical-network-gre-enable.png new file mode 100644 index 0000000000..40c54182c0 Binary files /dev/null and b/source/_static/images/legacy/ovs-physical-network-gre-enable.png differ diff --git a/source/_static/images/legacy/ovs-physical-network-gre.png b/source/_static/images/legacy/ovs-physical-network-gre.png new file mode 100644 index 0000000000..1e8bb00d7c Binary files /dev/null and b/source/_static/images/legacy/ovs-physical-network-gre.png differ diff --git a/source/_static/images/plugin4.jpg b/source/_static/images/legacy/plugin4.jpg similarity index 100% rename from source/_static/images/plugin4.jpg rename to source/_static/images/legacy/plugin4.jpg diff --git a/source/_static/images/plugin_intro.jpg b/source/_static/images/legacy/plugin_intro.jpg similarity index 100% rename from source/_static/images/plugin_intro.jpg rename to source/_static/images/legacy/plugin_intro.jpg diff --git a/source/_static/images/legacy/release-ip-icon.png b/source/_static/images/legacy/release-ip-icon.png new file mode 100644 index 0000000000..aa9846cfd9 Binary files /dev/null and b/source/_static/images/legacy/release-ip-icon.png differ diff --git a/source/_static/images/legacy/remove-nic.png b/source/_static/images/legacy/remove-nic.png new file mode 100644 index 0000000000..27145cebbc Binary files /dev/null and b/source/_static/images/legacy/remove-nic.png differ diff --git a/source/_static/images/remove-tier.png b/source/_static/images/legacy/remove-tier.png similarity index 100% rename from source/_static/images/remove-tier.png rename to source/_static/images/legacy/remove-tier.png diff --git a/source/_static/images/legacy/remove-vpc.png b/source/_static/images/legacy/remove-vpc.png new file mode 100644 index 0000000000..aa9846cfd9 Binary files /dev/null and b/source/_static/images/legacy/remove-vpc.png differ diff --git a/source/_static/images/legacy/remove-vpn.png b/source/_static/images/legacy/remove-vpn.png new file mode 100644 index 0000000000..27145cebbc Binary files /dev/null and b/source/_static/images/legacy/remove-vpn.png differ diff --git a/source/_static/images/legacy/replace-acl-icon.png b/source/_static/images/legacy/replace-acl-icon.png new file mode 100644 index 0000000000..ae953ba203 Binary files /dev/null and b/source/_static/images/legacy/replace-acl-icon.png differ diff --git a/source/_static/images/replace-acl-list.png b/source/_static/images/legacy/replace-acl-list.png similarity index 100% rename from source/_static/images/replace-acl-list.png rename to source/_static/images/legacy/replace-acl-list.png diff --git a/source/_static/images/legacy/reset-vpn.png b/source/_static/images/legacy/reset-vpn.png new file mode 100644 index 0000000000..04655dc37a Binary files /dev/null and b/source/_static/images/legacy/reset-vpn.png differ diff --git a/source/_static/images/legacy/resize-volume-icon.png b/source/_static/images/legacy/resize-volume-icon.png new file mode 100644 index 0000000000..48499021f0 Binary files /dev/null and b/source/_static/images/legacy/resize-volume-icon.png differ diff --git a/source/_static/images/legacy/resize-volume.png b/source/_static/images/legacy/resize-volume.png new file mode 100644 index 0000000000..6195623ab4 Binary files /dev/null and b/source/_static/images/legacy/resize-volume.png differ diff --git a/source/_static/images/legacy/restart-vpc.png b/source/_static/images/legacy/restart-vpc.png new file mode 100644 index 0000000000..04655dc37a Binary files /dev/null and b/source/_static/images/legacy/restart-vpc.png differ diff --git a/source/_static/images/legacy/revert-vm.png b/source/_static/images/legacy/revert-vm.png new file mode 100644 index 0000000000..04655dc37a Binary files /dev/null and b/source/_static/images/legacy/revert-vm.png differ diff --git a/source/_static/images/legacy/run-diagnostics-icon.png b/source/_static/images/legacy/run-diagnostics-icon.png new file mode 100644 index 0000000000..61e2aac443 Binary files /dev/null and b/source/_static/images/legacy/run-diagnostics-icon.png differ diff --git a/source/_static/images/s3-ss.png b/source/_static/images/legacy/s3-ss.png similarity index 100% rename from source/_static/images/s3-ss.png rename to source/_static/images/legacy/s3-ss.png diff --git a/source/_static/images/legacy/search-button.png b/source/_static/images/legacy/search-button.png new file mode 100644 index 0000000000..f329aef4a2 Binary files /dev/null and b/source/_static/images/legacy/search-button.png differ diff --git a/source/_static/images/legacy/select-vm-staticnat-vpc.png b/source/_static/images/legacy/select-vm-staticnat-vpc.png new file mode 100644 index 0000000000..12fde26d88 Binary files /dev/null and b/source/_static/images/legacy/select-vm-staticnat-vpc.png differ diff --git a/source/_static/images/legacy/set-default-nic.png b/source/_static/images/legacy/set-default-nic.png new file mode 100644 index 0000000000..f329aef4a2 Binary files /dev/null and b/source/_static/images/legacy/set-default-nic.png differ diff --git a/source/_static/images/legacy/stop-instance-icon.png b/source/_static/images/legacy/stop-instance-icon.png new file mode 100644 index 0000000000..209afce508 Binary files /dev/null and b/source/_static/images/legacy/stop-instance-icon.png differ diff --git a/source/_static/images/legacy/suspend-icon.png b/source/_static/images/legacy/suspend-icon.png new file mode 100644 index 0000000000..cab31ae3d5 Binary files /dev/null and b/source/_static/images/legacy/suspend-icon.png differ diff --git a/source/_static/images/template-permissions-update-1.PNG b/source/_static/images/legacy/template-permissions-update-1.PNG similarity index 100% rename from source/_static/images/template-permissions-update-1.PNG rename to source/_static/images/legacy/template-permissions-update-1.PNG diff --git a/source/_static/images/legacy/template-permissions-update-1.png b/source/_static/images/legacy/template-permissions-update-1.png new file mode 100644 index 0000000000..f1961c13e0 Binary files /dev/null and b/source/_static/images/legacy/template-permissions-update-1.png differ diff --git a/source/_static/images/template-permissions-update-2.PNG b/source/_static/images/legacy/template-permissions-update-2.PNG similarity index 100% rename from source/_static/images/template-permissions-update-2.PNG rename to source/_static/images/legacy/template-permissions-update-2.PNG diff --git a/source/_static/images/template-permissions-update-3.PNG b/source/_static/images/legacy/template-permissions-update-3.PNG similarity index 100% rename from source/_static/images/template-permissions-update-3.PNG rename to source/_static/images/legacy/template-permissions-update-3.PNG diff --git a/source/_static/images/template-permissions-update-4.PNG b/source/_static/images/legacy/template-permissions-update-4.PNG similarity index 100% rename from source/_static/images/template-permissions-update-4.PNG rename to source/_static/images/legacy/template-permissions-update-4.PNG diff --git a/source/_static/images/template-permissions-update-5.PNG b/source/_static/images/legacy/template-permissions-update-5.PNG similarity index 100% rename from source/_static/images/template-permissions-update-5.PNG rename to source/_static/images/legacy/template-permissions-update-5.PNG diff --git a/source/_static/images/template-permissions-update-manually-1.PNG b/source/_static/images/legacy/template-permissions-update-manually-1.PNG similarity index 100% rename from source/_static/images/template-permissions-update-manually-1.PNG rename to source/_static/images/legacy/template-permissions-update-manually-1.PNG diff --git a/source/_static/images/template-permissions-update-manually-2.PNG b/source/_static/images/legacy/template-permissions-update-manually-2.PNG similarity index 100% rename from source/_static/images/template-permissions-update-manually-2.PNG rename to source/_static/images/legacy/template-permissions-update-manually-2.PNG diff --git a/source/_static/images/update-ssl-icon.png b/source/_static/images/legacy/update-ssl-icon.png similarity index 100% rename from source/_static/images/update-ssl-icon.png rename to source/_static/images/legacy/update-ssl-icon.png diff --git a/source/_static/images/legacy/update-ssl.png b/source/_static/images/legacy/update-ssl.png new file mode 100644 index 0000000000..2f2ee535ba Binary files /dev/null and b/source/_static/images/legacy/update-ssl.png differ diff --git a/source/_static/images/legacy/upload-iso-from-local.png b/source/_static/images/legacy/upload-iso-from-local.png new file mode 100644 index 0000000000..cb34c62034 Binary files /dev/null and b/source/_static/images/legacy/upload-iso-from-local.png differ diff --git a/source/_static/images/view-console-button.png b/source/_static/images/legacy/view-console-button.png similarity index 100% rename from source/_static/images/view-console-button.png rename to source/_static/images/legacy/view-console-button.png diff --git a/source/_static/images/view-systemvm-details.png b/source/_static/images/legacy/view-systemvm-details.png similarity index 100% rename from source/_static/images/view-systemvm-details.png rename to source/_static/images/legacy/view-systemvm-details.png diff --git a/source/_static/images/vm-settings-dropdown-list.PNG b/source/_static/images/legacy/vm-settings-dropdown-list.PNG similarity index 100% rename from source/_static/images/vm-settings-dropdown-list.PNG rename to source/_static/images/legacy/vm-settings-dropdown-list.PNG diff --git a/source/_static/images/vm-settings-values-dropdown-KVM-list.PNG b/source/_static/images/legacy/vm-settings-values-dropdown-KVM-list.PNG similarity index 100% rename from source/_static/images/vm-settings-values-dropdown-KVM-list.PNG rename to source/_static/images/legacy/vm-settings-values-dropdown-KVM-list.PNG diff --git a/source/_static/images/legacy/vm-settings-values-dropdown-KVM-list.png b/source/_static/images/legacy/vm-settings-values-dropdown-KVM-list.png new file mode 100644 index 0000000000..1302f4ba12 Binary files /dev/null and b/source/_static/images/legacy/vm-settings-values-dropdown-KVM-list.png differ diff --git a/source/_static/images/vm-settings-values-dropdown-list.PNG b/source/_static/images/legacy/vm-settings-values-dropdown-list.PNG similarity index 100% rename from source/_static/images/vm-settings-values-dropdown-list.PNG rename to source/_static/images/legacy/vm-settings-values-dropdown-list.PNG diff --git a/source/_static/images/vm-settings-values1-dropdown-list.PNG b/source/_static/images/legacy/vm-settings-values1-dropdown-list.PNG similarity index 100% rename from source/_static/images/vm-settings-values1-dropdown-list.PNG rename to source/_static/images/legacy/vm-settings-values1-dropdown-list.PNG diff --git a/source/_static/images/volume-metrics-customized-view.JPG b/source/_static/images/legacy/volume-metrics-customized-view.JPG similarity index 100% rename from source/_static/images/volume-metrics-customized-view.JPG rename to source/_static/images/legacy/volume-metrics-customized-view.JPG diff --git a/source/_static/images/vpc-setting.png b/source/_static/images/legacy/vpc-setting.png similarity index 100% rename from source/_static/images/vpc-setting.png rename to source/_static/images/legacy/vpc-setting.png diff --git a/source/_static/images/legacy/vpn-icon.png b/source/_static/images/legacy/vpn-icon.png new file mode 100644 index 0000000000..2ac12f77c4 Binary files /dev/null and b/source/_static/images/legacy/vpn-icon.png differ diff --git a/source/_static/images/legacy/vr-upgrade.png b/source/_static/images/legacy/vr-upgrade.png new file mode 100644 index 0000000000..42417e278d Binary files /dev/null and b/source/_static/images/legacy/vr-upgrade.png differ diff --git a/source/_static/images/legacy/vxlan-physicalnetwork.png b/source/_static/images/legacy/vxlan-physicalnetwork.png new file mode 100644 index 0000000000..eb06fcd22e Binary files /dev/null and b/source/_static/images/legacy/vxlan-physicalnetwork.png differ diff --git a/source/_static/images/legacy/vxlan-trafficlabel.png b/source/_static/images/legacy/vxlan-trafficlabel.png new file mode 100644 index 0000000000..916e944168 Binary files /dev/null and b/source/_static/images/legacy/vxlan-trafficlabel.png differ diff --git a/source/_static/images/legacy/vxlan-vniconfig.png b/source/_static/images/legacy/vxlan-vniconfig.png new file mode 100644 index 0000000000..c7372a0f54 Binary files /dev/null and b/source/_static/images/legacy/vxlan-vniconfig.png differ diff --git a/source/_static/images/workloads.png b/source/_static/images/legacy/workloads.png similarity index 100% rename from source/_static/images/workloads.png rename to source/_static/images/legacy/workloads.png diff --git a/source/_static/images/migrate-instance.png b/source/_static/images/migrate-instance.png index 25ff57245b..d255f5ac7d 100644 Binary files a/source/_static/images/migrate-instance.png and b/source/_static/images/migrate-instance.png differ diff --git a/source/_static/images/networking-egress-rule.png b/source/_static/images/networking-egress-rule.png index edf1f6d885..8116f98313 100644 Binary files a/source/_static/images/networking-egress-rule.png and b/source/_static/images/networking-egress-rule.png differ diff --git a/source/_static/images/networking-infra-traffic-labels.png b/source/_static/images/networking-infra-traffic-labels.png index e029d7dd85..bc6e8188b0 100644 Binary files a/source/_static/images/networking-infra-traffic-labels.png and b/source/_static/images/networking-infra-traffic-labels.png differ diff --git a/source/_static/images/networking-ingress-rule.png b/source/_static/images/networking-ingress-rule.png index 8b1af227f1..6b124078ed 100644 Binary files a/source/_static/images/networking-ingress-rule.png and b/source/_static/images/networking-ingress-rule.png differ diff --git a/source/_static/images/networking-zone-traffic-labels.png b/source/_static/images/networking-zone-traffic-labels.png index 1587c2b6e5..20287227e5 100644 Binary files a/source/_static/images/networking-zone-traffic-labels.png and b/source/_static/images/networking-zone-traffic-labels.png differ diff --git a/source/_static/images/nuage_iso_net_off.png b/source/_static/images/nuage_iso_net_off.png deleted file mode 100644 index 2ebb03b8e0..0000000000 Binary files a/source/_static/images/nuage_iso_net_off.png and /dev/null differ diff --git a/source/_static/images/nuage_kvm_traffic_label.jpg b/source/_static/images/nuage_kvm_traffic_label.jpg deleted file mode 100644 index e81c0f5011..0000000000 Binary files a/source/_static/images/nuage_kvm_traffic_label.jpg and /dev/null differ diff --git a/source/_static/images/nuage_sha_net_off.png b/source/_static/images/nuage_sha_net_off.png deleted file mode 100644 index 71ddcfca5b..0000000000 Binary files a/source/_static/images/nuage_sha_net_off.png and /dev/null differ diff --git a/source/_static/images/nuage_source_nat_net_off.png b/source/_static/images/nuage_source_nat_net_off.png deleted file mode 100644 index 00f7955586..0000000000 Binary files a/source/_static/images/nuage_source_nat_net_off.png and /dev/null differ diff --git a/source/_static/images/nuage_underlay_api_usage.png b/source/_static/images/nuage_underlay_api_usage.png deleted file mode 100644 index 6761dc837d..0000000000 Binary files a/source/_static/images/nuage_underlay_api_usage.png and /dev/null differ diff --git a/source/_static/images/nuage_vmware_traffic_label.jpg b/source/_static/images/nuage_vmware_traffic_label.jpg deleted file mode 100644 index 6f7a7c1f6e..0000000000 Binary files a/source/_static/images/nuage_vmware_traffic_label.jpg and /dev/null differ diff --git a/source/_static/images/nuage_vpc_net_off.png b/source/_static/images/nuage_vpc_net_off.png deleted file mode 100644 index b45e8fe1de..0000000000 Binary files a/source/_static/images/nuage_vpc_net_off.png and /dev/null differ diff --git a/source/_static/images/nuage_vpc_off.png b/source/_static/images/nuage_vpc_off.png deleted file mode 100644 index a353e2fb9a..0000000000 Binary files a/source/_static/images/nuage_vpc_off.png and /dev/null differ diff --git a/source/_static/images/nuage_vsd_device_add.png b/source/_static/images/nuage_vsd_device_add.png deleted file mode 100644 index 60513d2f99..0000000000 Binary files a/source/_static/images/nuage_vsd_device_add.png and /dev/null differ diff --git a/source/_static/images/nuage_vsp_isolation_method_setting.png b/source/_static/images/nuage_vsp_isolation_method_setting.png deleted file mode 100644 index 9dabf9a61a..0000000000 Binary files a/source/_static/images/nuage_vsp_isolation_method_setting.png and /dev/null differ diff --git a/source/_static/images/nuage_vsp_nsp_enable.png b/source/_static/images/nuage_vsp_nsp_enable.png deleted file mode 100644 index df7f0b4eee..0000000000 Binary files a/source/_static/images/nuage_vsp_nsp_enable.png and /dev/null differ diff --git a/source/_static/images/nuage_vsp_nsp_status.png b/source/_static/images/nuage_vsp_nsp_status.png deleted file mode 100644 index c8dd02e0d5..0000000000 Binary files a/source/_static/images/nuage_vsp_nsp_status.png and /dev/null differ diff --git a/source/_static/images/nuage_vsp_vpc_off.png b/source/_static/images/nuage_vsp_vpc_off.png deleted file mode 100644 index b1c4f29366..0000000000 Binary files a/source/_static/images/nuage_vsp_vpc_off.png and /dev/null differ diff --git a/source/_static/images/nvp-add-controller.png b/source/_static/images/nvp-add-controller.png index e02d31f0a3..e73675f96e 100644 Binary files a/source/_static/images/nvp-add-controller.png and b/source/_static/images/nvp-add-controller.png differ diff --git a/source/_static/images/nvp-enable-provider.png b/source/_static/images/nvp-enable-provider.png index 0f2d02ddfa..57ccaf1659 100644 Binary files a/source/_static/images/nvp-enable-provider.png and b/source/_static/images/nvp-enable-provider.png differ diff --git a/source/_static/images/nvp-network-offering.png b/source/_static/images/nvp-network-offering.png index c2d25c48c1..4a0dddeeec 100644 Binary files a/source/_static/images/nvp-network-offering.png and b/source/_static/images/nvp-network-offering.png differ diff --git a/source/_static/images/nvp-physical-network-stt.png b/source/_static/images/nvp-physical-network-stt.png index 2ce7853ac5..10f65a2c1b 100644 Binary files a/source/_static/images/nvp-physical-network-stt.png and b/source/_static/images/nvp-physical-network-stt.png differ diff --git a/source/_static/images/ovs-network-offering.png b/source/_static/images/ovs-network-offering.png index 750c5f09b1..1cf95a49e8 100644 Binary files a/source/_static/images/ovs-network-offering.png and b/source/_static/images/ovs-network-offering.png differ diff --git a/source/_static/images/ovs-physical-network-gre-enable.png b/source/_static/images/ovs-physical-network-gre-enable.png index 40c54182c0..d59ae311d0 100644 Binary files a/source/_static/images/ovs-physical-network-gre-enable.png and b/source/_static/images/ovs-physical-network-gre-enable.png differ diff --git a/source/_static/images/ovs-physical-network-gre.png b/source/_static/images/ovs-physical-network-gre.png index 1e8bb00d7c..eacc09244e 100644 Binary files a/source/_static/images/ovs-physical-network-gre.png and b/source/_static/images/ovs-physical-network-gre.png differ diff --git a/source/_static/images/plugin4.png b/source/_static/images/plugin4.png new file mode 100644 index 0000000000..8cf28beed1 Binary files /dev/null and b/source/_static/images/plugin4.png differ diff --git a/source/_static/images/plugin_intro.png b/source/_static/images/plugin_intro.png new file mode 100644 index 0000000000..f166e3b14a Binary files /dev/null and b/source/_static/images/plugin_intro.png differ diff --git a/source/_static/images/release-ip-icon.png b/source/_static/images/release-ip-icon.png index aa9846cfd9..60b5e3982b 100644 Binary files a/source/_static/images/release-ip-icon.png and b/source/_static/images/release-ip-icon.png differ diff --git a/source/_static/images/remove-nic.png b/source/_static/images/remove-nic.png index 27145cebbc..60b5e3982b 100644 Binary files a/source/_static/images/remove-nic.png and b/source/_static/images/remove-nic.png differ diff --git a/source/_static/images/remove-vpc.png b/source/_static/images/remove-vpc.png index aa9846cfd9..60b5e3982b 100644 Binary files a/source/_static/images/remove-vpc.png and b/source/_static/images/remove-vpc.png differ diff --git a/source/_static/images/remove-vpn.png b/source/_static/images/remove-vpn.png index 27145cebbc..60b5e3982b 100644 Binary files a/source/_static/images/remove-vpn.png and b/source/_static/images/remove-vpn.png differ diff --git a/source/_static/images/replace-acl-icon.png b/source/_static/images/replace-acl-icon.png index ae953ba203..91da3070f6 100644 Binary files a/source/_static/images/replace-acl-icon.png and b/source/_static/images/replace-acl-icon.png differ diff --git a/source/_static/images/reset-vpn.png b/source/_static/images/reset-vpn.png index 04655dc37a..1a5c910608 100644 Binary files a/source/_static/images/reset-vpn.png and b/source/_static/images/reset-vpn.png differ diff --git a/source/_static/images/resize-volume-icon.png b/source/_static/images/resize-volume-icon.png index 48499021f0..94b249cad0 100644 Binary files a/source/_static/images/resize-volume-icon.png and b/source/_static/images/resize-volume-icon.png differ diff --git a/source/_static/images/resize-volume.png b/source/_static/images/resize-volume.png index 6195623ab4..75c63ab7a9 100644 Binary files a/source/_static/images/resize-volume.png and b/source/_static/images/resize-volume.png differ diff --git a/source/_static/images/restart-vpc.png b/source/_static/images/restart-vpc.png index 04655dc37a..07a32bdcc4 100644 Binary files a/source/_static/images/restart-vpc.png and b/source/_static/images/restart-vpc.png differ diff --git a/source/_static/images/revert-vm.png b/source/_static/images/revert-vm.png index 04655dc37a..07a32bdcc4 100644 Binary files a/source/_static/images/revert-vm.png and b/source/_static/images/revert-vm.png differ diff --git a/source/_static/images/run-diagnostics-icon.png b/source/_static/images/run-diagnostics-icon.png index 61e2aac443..7606feb0e7 100644 Binary files a/source/_static/images/run-diagnostics-icon.png and b/source/_static/images/run-diagnostics-icon.png differ diff --git a/source/_static/images/search-button.png b/source/_static/images/search-button.png index f329aef4a2..fc10f8c068 100644 Binary files a/source/_static/images/search-button.png and b/source/_static/images/search-button.png differ diff --git a/source/_static/images/select-vm-staticnat-vpc.png b/source/_static/images/select-vm-staticnat-vpc.png index 12fde26d88..99e8148eba 100644 Binary files a/source/_static/images/select-vm-staticnat-vpc.png and b/source/_static/images/select-vm-staticnat-vpc.png differ diff --git a/source/_static/images/set-default-nic.png b/source/_static/images/set-default-nic.png index f329aef4a2..5960c6940d 100644 Binary files a/source/_static/images/set-default-nic.png and b/source/_static/images/set-default-nic.png differ diff --git a/source/_static/images/stop-instance-icon.png b/source/_static/images/stop-instance-icon.png index 209afce508..de7e47a3db 100644 Binary files a/source/_static/images/stop-instance-icon.png and b/source/_static/images/stop-instance-icon.png differ diff --git a/source/_static/images/suspend-icon.png b/source/_static/images/suspend-icon.png index cab31ae3d5..0b1d2880f8 100644 Binary files a/source/_static/images/suspend-icon.png and b/source/_static/images/suspend-icon.png differ diff --git a/source/_static/images/template-permissions-update-1.png b/source/_static/images/template-permissions-update-1.png new file mode 100644 index 0000000000..20819fabf0 Binary files /dev/null and b/source/_static/images/template-permissions-update-1.png differ diff --git a/source/_static/images/template-permissions-update-2.png b/source/_static/images/template-permissions-update-2.png new file mode 100644 index 0000000000..ffe18b0048 Binary files /dev/null and b/source/_static/images/template-permissions-update-2.png differ diff --git a/source/_static/images/template-permissions-update-3.png b/source/_static/images/template-permissions-update-3.png new file mode 100644 index 0000000000..08253961ed Binary files /dev/null and b/source/_static/images/template-permissions-update-3.png differ diff --git a/source/_static/images/template-permissions-update-4.png b/source/_static/images/template-permissions-update-4.png new file mode 100644 index 0000000000..6762586577 Binary files /dev/null and b/source/_static/images/template-permissions-update-4.png differ diff --git a/source/_static/images/template-permissions-update-5.png b/source/_static/images/template-permissions-update-5.png new file mode 100644 index 0000000000..22ea751b8b Binary files /dev/null and b/source/_static/images/template-permissions-update-5.png differ diff --git a/source/_static/images/template-permissions-update-manually-1.png b/source/_static/images/template-permissions-update-manually-1.png new file mode 100644 index 0000000000..b2701d08dc Binary files /dev/null and b/source/_static/images/template-permissions-update-manually-1.png differ diff --git a/source/_static/images/template-permissions-update-manually-2.png b/source/_static/images/template-permissions-update-manually-2.png new file mode 100644 index 0000000000..dff1e3d249 Binary files /dev/null and b/source/_static/images/template-permissions-update-manually-2.png differ diff --git a/source/_static/images/template-upload-from-local.PNG b/source/_static/images/template-upload-from-local.PNG deleted file mode 100644 index b924617ea6..0000000000 Binary files a/source/_static/images/template-upload-from-local.PNG and /dev/null differ diff --git a/source/_static/images/template-upload-from-local.png b/source/_static/images/template-upload-from-local.png new file mode 100644 index 0000000000..27b477c9df Binary files /dev/null and b/source/_static/images/template-upload-from-local.png differ diff --git a/source/_static/images/update-service-offering-button.jpg b/source/_static/images/update-service-offering-button.jpg deleted file mode 100644 index e282a04559..0000000000 Binary files a/source/_static/images/update-service-offering-button.jpg and /dev/null differ diff --git a/source/_static/images/update-service-offering-button.png b/source/_static/images/update-service-offering-button.png new file mode 100644 index 0000000000..699b661b46 Binary files /dev/null and b/source/_static/images/update-service-offering-button.png differ diff --git a/source/_static/images/update-ssl.png b/source/_static/images/update-ssl.png index 2f2ee535ba..4f9f79ffac 100644 Binary files a/source/_static/images/update-ssl.png and b/source/_static/images/update-ssl.png differ diff --git a/source/_static/images/upload-iso-from-local.png b/source/_static/images/upload-iso-from-local.png index cb34c62034..ea0b9e2eff 100644 Binary files a/source/_static/images/upload-iso-from-local.png and b/source/_static/images/upload-iso-from-local.png differ diff --git a/source/_static/images/vm-settings-dropdown-list.png b/source/_static/images/vm-settings-dropdown-list.png new file mode 100644 index 0000000000..de2a21df37 Binary files /dev/null and b/source/_static/images/vm-settings-dropdown-list.png differ diff --git a/source/_static/images/vm-settings-values-dropdown-KVM-list.png b/source/_static/images/vm-settings-values-dropdown-KVM-list.png new file mode 100644 index 0000000000..1302f4ba12 Binary files /dev/null and b/source/_static/images/vm-settings-values-dropdown-KVM-list.png differ diff --git a/source/_static/images/vm-settings-values-dropdown-list.png b/source/_static/images/vm-settings-values-dropdown-list.png new file mode 100644 index 0000000000..241a00fbe6 Binary files /dev/null and b/source/_static/images/vm-settings-values-dropdown-list.png differ diff --git a/source/_static/images/vm-settings-values1-dropdown-list.png b/source/_static/images/vm-settings-values1-dropdown-list.png new file mode 100644 index 0000000000..60422f60cd Binary files /dev/null and b/source/_static/images/vm-settings-values1-dropdown-list.png differ diff --git a/source/_static/images/volume-from-snap.PNG b/source/_static/images/volume-from-snap.PNG deleted file mode 100644 index 5eb9a5e616..0000000000 Binary files a/source/_static/images/volume-from-snap.PNG and /dev/null differ diff --git a/source/_static/images/volume-from-snap.png b/source/_static/images/volume-from-snap.png new file mode 100644 index 0000000000..eec0c837a9 Binary files /dev/null and b/source/_static/images/volume-from-snap.png differ diff --git a/source/_static/images/vpn-icon.png b/source/_static/images/vpn-icon.png index 2ac12f77c4..d495b1bcdf 100644 Binary files a/source/_static/images/vpn-icon.png and b/source/_static/images/vpn-icon.png differ diff --git a/source/_static/images/vr-upgrade.png b/source/_static/images/vr-upgrade.png index 42417e278d..94b249cad0 100644 Binary files a/source/_static/images/vr-upgrade.png and b/source/_static/images/vr-upgrade.png differ diff --git a/source/_static/images/vxlan-physicalnetwork.png b/source/_static/images/vxlan-physicalnetwork.png index eb06fcd22e..ee0ae630d0 100644 Binary files a/source/_static/images/vxlan-physicalnetwork.png and b/source/_static/images/vxlan-physicalnetwork.png differ diff --git a/source/_static/images/vxlan-trafficlabel.png b/source/_static/images/vxlan-trafficlabel.png index 916e944168..106759e378 100644 Binary files a/source/_static/images/vxlan-trafficlabel.png and b/source/_static/images/vxlan-trafficlabel.png differ diff --git a/source/_static/images/vxlan-vniconfig.png b/source/_static/images/vxlan-vniconfig.png index c7372a0f54..bd0e63e0bc 100644 Binary files a/source/_static/images/vxlan-vniconfig.png and b/source/_static/images/vxlan-vniconfig.png differ diff --git a/source/adminguide/autoscale_without_netscaler.rst b/source/adminguide/autoscale_without_netscaler.rst index e2f5799f7a..055d44f976 100644 --- a/source/adminguide/autoscale_without_netscaler.rst +++ b/source/adminguide/autoscale_without_netscaler.rst @@ -17,27 +17,32 @@ Configuring AutoScale without using NetScaler ============================================= -.. warning:: - This feature is currently only available on the master branch and will be +.. warning:: + This feature is currently only available on the master branch and will be released in the 4.4 release. +.. note:: + AutoScaling is currently not supported in the new UI. + To manage AutoScaling, please directly invoke the + respective APIs or use `cloudmonkey `_, + the CLI tool for cloudstack What is AutoScaling? -------------------- -AutoScaling allows you to scale your back-end services or application VMs up -or down seamlessly and automatically according to the conditions you define. -With AutoScaling enabled, you can ensure that the number of VMs you are using -seamlessly scale up when demand increases, and automatically decreases when -demand subsides. Thus it helps you save compute costs by terminating underused -VMs automatically and launching new VMs when you need them, without the need +AutoScaling allows you to scale your back-end services or application VMs up +or down seamlessly and automatically according to the conditions you define. +With AutoScaling enabled, you can ensure that the number of VMs you are using +seamlessly scale up when demand increases, and automatically decreases when +demand subsides. Thus it helps you save compute costs by terminating underused +VMs automatically and launching new VMs when you need them, without the need for manual intervention. Hypervisor support ------------------ -At that time, AutoScaling without NetScaler only supports for Xenserver. We +At that time, AutoScaling without NetScaler only supports for Xenserver. We are working to support KVM also. @@ -46,10 +51,10 @@ Prerequisites Before you configure an AutoScale rule, consider the following: -- Ensure that the necessary template is prepared before configuring AutoScale. - Firstly you must install the PV-driver, which helps Xenserver collect - performance parameters (CPU and memory) into VMs. Beside, When a VM is - deployed by using a template and when it comes up, the application should be +- Ensure that the necessary template is prepared before configuring AutoScale. + Firstly you must install the PV-driver, which helps Xenserver collect + performance parameters (CPU and memory) into VMs. Beside, When a VM is + deployed by using a template and when it comes up, the application should be up and running. @@ -60,77 +65,77 @@ Specify the following: .. image:: /_static/images/autoscale-config.png -- Template: A template consists of a base OS image and application. A - template is used to provision the new instance of an application on a - scaleup action. When a VM is deployed from a template, the VM can start - taking the traffic from the load balancer without any admin intervention. - For example, if the VM is deployed for a Web service, it should have the +- Template: A template consists of a base OS image and application. A + template is used to provision the new instance of an application on a + scaleup action. When a VM is deployed from a template, the VM can start + taking the traffic from the load balancer without any admin intervention. + For example, if the VM is deployed for a Web service, it should have the Web server running, the database connected, and so on. -- Compute offering: A predefined set of virtual hardware attributes, - including CPU speed, number of CPUs, and RAM size, that the user can select - when creating a new virtual machine instance. Choose one of the compute - offerings to be used while provisioning a VM instance as part of scaleup +- Compute offering: A predefined set of virtual hardware attributes, + including CPU speed, number of CPUs, and RAM size, that the user can select + when creating a new virtual machine instance. Choose one of the compute + offerings to be used while provisioning a VM instance as part of scaleup action. -- Min Instance: The minimum number of active VM instances that is assigned to - a load balancing rule. The active VM instances are the application - instances that are up and serving the traffic, and are being load balanced. - This parameter ensures that a load balancing rule has at least the +- Min Instance: The minimum number of active VM instances that is assigned to + a load balancing rule. The active VM instances are the application + instances that are up and serving the traffic, and are being load balanced. + This parameter ensures that a load balancing rule has at least the configured number of active VM instances are available to serve the traffic. -- Max Instance: Maximum number of active VM instances that should be assigned - to a load balancing rule. This parameter defines the upper limit of active +- Max Instance: Maximum number of active VM instances that should be assigned + to a load balancing rule. This parameter defines the upper limit of active VM instances that can be assigned to a load balancing rule. - Specifying a large value for the maximum instance parameter might result in - provisioning large number of VM instances, which in turn leads to a single - load balancing rule exhausting the VM instances limit specified at the + Specifying a large value for the maximum instance parameter might result in + provisioning large number of VM instances, which in turn leads to a single + load balancing rule exhausting the VM instances limit specified at the account or domain level. Specify the following scale-up and scale-down policies: -- Duration: The duration, in seconds, for which the conditions you specify - must be true to trigger a scaleup action. The conditions defined should - hold true for the entire duration you specify for an AutoScale action to be +- Duration: The duration, in seconds, for which the conditions you specify + must be true to trigger a scaleup action. The conditions defined should + hold true for the entire duration you specify for an AutoScale action to be invoked. -- Counter: The performance counters expose the state of the monitored +- Counter: The performance counters expose the state of the monitored instances. We added two new counter to work with that feature: - Linux User CPU [native] - percentage - Linux User RAM [native] - percentage - Remember to choose one of them. If you choose anything else, the + Remember to choose one of them. If you choose anything else, the autoscaling will not work. -- Operator: The following five relational operators are supported in - AutoScale feature: Greater than, Less than, Less than or equal to, Greater +- Operator: The following five relational operators are supported in + AutoScale feature: Greater than, Less than, Less than or equal to, Greater than or equal to, and Equal to. -- Threshold: Threshold value to be used for the counter. Once the counter - defined above breaches the threshold value, the AutoScale feature initiates +- Threshold: Threshold value to be used for the counter. Once the counter + defined above breaches the threshold value, the AutoScale feature initiates a scaleup or scaledown action. - Add: Click Add to add the condition. - Additionally, if you want to configure the advanced settings, click Show + Additionally, if you want to configure the advanced settings, click Show advanced settings, and specify the following: -- Polling interval: Frequency in which the conditions, combination of counter, - operator and threshold, are to be evaluated before taking a scale up or +- Polling interval: Frequency in which the conditions, combination of counter, + operator and threshold, are to be evaluated before taking a scale up or down action. The default polling interval is 30 seconds. -- Quiet Time: This is the cool down period after an AutoScale action is - initiated. The time includes the time taken to complete provisioning a VM - instance from its template and the time taken by an application to be ready - to serve traffic. This quiet time allows the fleet to come up to a stable +- Quiet Time: This is the cool down period after an AutoScale action is + initiated. The time includes the time taken to complete provisioning a VM + instance from its template and the time taken by an application to be ready + to serve traffic. This quiet time allows the fleet to come up to a stable state before any action can take place. The default is 300 seconds. -- Destroy VM Grace Period: The duration in seconds, after a scaledown action - is initiated, to wait before the VM is destroyed as part of scaledown - action. This is to ensure graceful close of any pending sessions or - transactions being served by the VM marked for destroy. The default is 120 +- Destroy VM Grace Period: The duration in seconds, after a scaledown action + is initiated, to wait before the VM is destroyed as part of scaledown + action. This is to ensure graceful close of any pending sessions or + transactions being served by the VM marked for destroy. The default is 120 seconds. - Apply: Click Apply to create the AutoScale configuration. @@ -139,39 +144,39 @@ Specify the following scale-up and scale-down policies: Disabling and Enabling an AutoScale Configuration ------------------------------------------------- -If you want to perform any maintenance operation on the AutoScale VM instances, -disable the AutoScale configuration. When the AutoScale configuration is -disabled, no scaleup or scaledown action is performed. You can use this -downtime for the maintenance activities. To disable the AutoScale +If you want to perform any maintenance operation on the AutoScale VM instances, +disable the AutoScale configuration. When the AutoScale configuration is +disabled, no scaleup or scaledown action is performed. You can use this +downtime for the maintenance activities. To disable the AutoScale configuration, click the Disable AutoScale button. -The button toggles between enable and disable, depending on whether AutoScale -is currently enabled or not. After the maintenance operations are done, you -can enable the AutoScale configuration back. To enable, open the AutoScale +The button toggles between enable and disable, depending on whether AutoScale +is currently enabled or not. After the maintenance operations are done, you +can enable the AutoScale configuration back. To enable, open the AutoScale configuration page again, then click the Enable AutoScale button. Updating an AutoScale Configuration ----------------------------------- -You can update the various parameters and add or delete the conditions in a -scaleup or scaledown rule. Before you update an AutoScale configuration, -ensure that you disable the AutoScale load balancer rule by clicking the +You can update the various parameters and add or delete the conditions in a +scaleup or scaledown rule. Before you update an AutoScale configuration, +ensure that you disable the AutoScale load balancer rule by clicking the Disable AutoScale button. -After you modify the required AutoScale parameters, click Apply. To apply the -new AutoScale policies, open the AutoScale configuration page again, then +After you modify the required AutoScale parameters, click Apply. To apply the +new AutoScale policies, open the AutoScale configuration page again, then click the Enable AutoScale button. Runtime Considerations ---------------------- -An administrator should not assign a VM to a load balancing rule which is +An administrator should not assign a VM to a load balancing rule which is configured for AutoScale. -Making API calls outside the context of AutoScale, such as destroyVM, on an -autoscaled VM leaves the load balancing configuration in an inconsistent state. -Though VM is destroyed from the load balancer rule, it continues be showed as +Making API calls outside the context of AutoScale, such as destroyVM, on an +autoscaled VM leaves the load balancing configuration in an inconsistent state. +Though VM is destroyed from the load balancer rule, it continues be showed as a service assigned to a rule inside the context of AutoScale. diff --git a/source/adminguide/backup_and_recovery.rst b/source/adminguide/backup_and_recovery.rst index a85a2a11f6..aaa6e565aa 100644 --- a/source/adminguide/backup_and_recovery.rst +++ b/source/adminguide/backup_and_recovery.rst @@ -12,7 +12,7 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + About Backup And Recovery -------------------------- @@ -41,7 +41,7 @@ Backup and recovery has been designed to support two modes: - Adhoc and user scheduled backups 'SLA' based backups are ones where the Cloud provider (ie the root admin) controls the time, and frequency of a backup scheme. -A user signs up for a 'Gold' offering, which might give them a RPO of 12 hours and the last 14 backups kept; however the user would not be +A user signs up for a 'Gold' offering, which might give them a RPO of 12 hours and the last 14 backups kept; however the user would not be allowed to perform additional backups nor set the exact time that these backups took place. The user might be charged a fix rate for these backups regardless of the size of the backups. @@ -89,7 +89,7 @@ backups. Users can list and consume the imported backup offerings, only root adm delete offerings. Supported APIs: -~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~ - **listBackupProviders**: lists available backup provider plugins - **listBackupProviderOfferings**: lists external backup policy/offering from a provider @@ -109,7 +109,7 @@ To import a backup provider offering; #. Enter your user-friendly name and description and select the applicable zone. The External ID will then be populated with the template jobs which CloudStack retrieves from the connected provider. - |B&R-backup_offering_policy.jpg| |B&R-backup_offering.jpg| + |B&R-backup_offering_policy.png| |B&R-backup_offering.png| Creating VM Backups --------------------- @@ -117,10 +117,10 @@ Creating VM Backups SLA/Policy Based backups ~~~~~~~~~~~~~~~~~~~~~~~~~ -With the backup and recovery feature enabled for a zone, users simply add and +With the backup and recovery feature enabled for a zone, users simply add and remove a VM from a backup offering. -|B&R-assignOffering.jpg| +|B&R-assignOffering.png| Adhoc and Scheduled Backups ~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -133,16 +133,16 @@ allowed to add/remove volumes similar to VM snapshots. To trigger an adhoc backup of a VM, navigate to the instance and click on the 'Create Backup' icon. -|B&R-createBackup.jpg| +|B&R-createBackup.png| To setup a recurring backup schedule, navigate to the instance and click on the 'Backup Schedule' icon. -|B&R-BackupSchedule.jpg| +|B&R-BackupSchedule.png| Then set the time and frequency of the backups, click 'Configure' and then 'Close' -|B&R-BackupScheduleEntry.jpg| +|B&R-BackupScheduleEntry.png| Restoring VM Backups --------------------- @@ -169,21 +169,21 @@ Supported APIs: - **restoreVolumeFromBackup**: restore and attach a backed-up volume (of a VM backup) to a specified VM. -.. |B&R-assignOffering.jpg| image:: /_static/images/B&R-assignOffering.jpg +.. |B&R-assignOffering.png| image:: /_static/images/B&R-assignOffering.png :alt: Assigning an SLA/Policy to a VM. :width: 400 px -.. |B&R-backup_offering_policy.jpg| image:: /_static/images/B&R-backup_offering_policy.jpg +.. |B&R-backup_offering_policy.png| image:: /_static/images/B&R-backup_offering_policy.png :alt: Importing an SLA/Policy offering. :width: 300 px -.. |B&R-backup_offering.jpg| image:: /_static/images/B&R-backup_offering.jpg +.. |B&R-backup_offering.png| image:: /_static/images/B&R-backup_offering.png :alt: Importing a template backup offering. :width: 300 px -.. |B&R-createBackup.jpg| image:: /_static/images/B&R-createBackup.jpg +.. |B&R-createBackup.png| image:: /_static/images/B&R-createBackup.png :alt: Triggering an adhoc backup for a VM. :width: 400 px -.. |B&R-BackupSchedule.jpg| image:: /_static/images/B&R-BackupSchedule.jpg +.. |B&R-BackupSchedule.png| image:: /_static/images/B&R-BackupSchedule.png :alt: Creating a backup schedule for a VM. :width: 400 px -.. |B&R-BackupScheduleEntry.jpg| image:: /_static/images/B&R-BackupScheduleEntry.jpg +.. |B&R-BackupScheduleEntry.png| image:: /_static/images/B&R-BackupScheduleEntry.png :alt: Creating a backup schedule for a VM. :width: 400px diff --git a/source/adminguide/networking.rst b/source/adminguide/networking.rst index dfd15edbd4..6b97075605 100644 --- a/source/adminguide/networking.rst +++ b/source/adminguide/networking.rst @@ -59,7 +59,7 @@ account. Isolated networks have the following properties. - The network offering can be upgraded or downgraded but it is for the entire network -For more information, see `“Configure Guest Traffic in an Advanced Zone” +For more information, see `“Configure Guest Traffic in an Advanced Zone” `_. @@ -84,7 +84,7 @@ Basic zones in CloudStack 3.0.3 and later versions. - Source NAT per zone is not supported in Shared Network when the service provider is virtual router. However, Source NAT per account - is supported. For information, see `“Configuring a Shared Guest + is supported. For information, see `“Configuring a Shared Guest Network” `_. @@ -93,7 +93,7 @@ L2 Networks L2 networks provide network isolation without any other services. This means that there will be no virtual router. It is assumed that the end -user will have their own IPAM in place, or that they will statically assign +user will have their own IPAM in place, or that they will statically assign IP addresses. - L2 networks can be created by the end users, however network offerings @@ -107,7 +107,7 @@ IP addresses. Example GUI dialog box (for a regular user account) is shown below: -|L2-networks-gui.JPG| +|L2-networks-gui.png| Runtime Allocation of Virtual Network Resources @@ -124,8 +124,8 @@ helps to conserve network resources. Network Service Providers ------------------------- -.. note:: - For the most up-to-date list of supported network service providers, +.. note:: + For the most up-to-date list of supported network service providers, see the CloudStack UI or call `listNetworkServiceProviders`. A service provider (also called a network element) is hardware or @@ -179,8 +179,8 @@ offering. Network Offerings ----------------- -.. note:: - For the most up-to-date list of supported network services, see the +.. note:: + For the most up-to-date list of supported network services, see the CloudStack UI or call listNetworkServices. A network offering is a named set of network services, such as: @@ -220,12 +220,12 @@ running a web server farm and require a scalable firewall solution, load balancing solution, and alternate networks for accessing the database backend. -.. note:: - If you create load balancing rules while using a network service - offering that includes an external load balancer device such as - NetScaler, and later change the network service offering to one that - uses the CloudStack virtual router, you must create a firewall rule - on the virtual router for each of your existing load balancing rules +.. note:: + If you create load balancing rules while using a network service + offering that includes an external load balancer device such as + NetScaler, and later change the network service offering to one that + uses the CloudStack virtual router, you must create a firewall rule + on the virtual router for each of your existing load balancing rules so that they continue to function. When creating a new virtual network, the CloudStack administrator @@ -298,9 +298,9 @@ To create a network offering: following supported services: .. cssclass:: table-striped table-bordered table-hover - + =================== ============================================================================ ============= ============= - Supported Services Description Isolated Shared + Supported Services Description Isolated Shared =================== ============================================================================ ============= ============= DHCP For more information, see `“DNS and Supported Supported DHCP” `_. @@ -340,7 +340,7 @@ To create a network offering: system service offering and any custom system service offerings that have been defined by the CloudStack root administrator. - For more information, see `“System Service Offerings” + For more information, see `“System Service Offerings” `_. - **LB Isolation**: Specify what type of load balancer isolation you @@ -371,7 +371,7 @@ To create a network offering: balancing traffic to the load balancer behind it. The load balancer in this case will not have the direct access to the public network. - + - **Side by Side**: In side by side mode, a firewall device is deployed in parallel with the load balancer device. So the traffic to the load balancer public IP is not routed through the firewall, @@ -386,7 +386,7 @@ To create a network offering: - Elastic IP is enabled. - For information on Elastic IP, see `“About Elastic IP” + For information on Elastic IP, see `“About Elastic IP” `_. - **Redundant router capability**: Available only when Virtual @@ -409,10 +409,10 @@ To create a network offering: the conserve mode is on, you can define more than one service on the same public IP. - .. note:: - If StaticNAT is enabled, irrespective of the status of the - conserve mode, no port forwarding or load balancing rule can be - created for the IP. However, you can add the firewall rules by + .. note:: + If StaticNAT is enabled, irrespective of the status of the + conserve mode, no port forwarding or load balancing rule can be + created for the IP. However, you can add the firewall rules by using the createFirewallRule command. - **Tags**: Network tag to specify which physical network to use. @@ -428,21 +428,21 @@ To create a network offering: guest network, rules are added to allow the specified traffic. - **Public**: Indicate whether the network offering should be available to - all domains or only some domains. Choose Yes to make it available to + all domains or only some domains. Choose Yes to make it available to all domains. Choose No to limit the scope to one or more domains. - **Domain**: This is only visible When ‘Public’ is unchecked. When visible, - this controls the domains which will be able to use this network offering. - A multi-selection list box will be displayed. One or more domains can be - selected from this list box by holding down the control key and selecting + this controls the domains which will be able to use this network offering. + A multi-selection list box will be displayed. One or more domains can be + selected from this list box by holding down the control key and selecting the desired domains. - - **Zone**: This controls which zones a network offering is available in. - ‘All zones’ or only specific zones can be selected. One or more zones can be - selected from this list box by holding down the control key and selecting + - **Zone**: This controls which zones a network offering is available in. + ‘All zones’ or only specific zones can be selected. One or more zones can be + selected from this list box by holding down the control key and selecting the desired zones. #. Click Add. -.. |L2-networks-gui.JPG| image:: /_static/images/L2-networks-gui.JPG +.. |L2-networks-gui.png| image:: /_static/images/L2-networks-gui.png :alt: Creating L2 network from GUI diff --git a/source/adminguide/networking/global_server_load_balancing.rst b/source/adminguide/networking/global_server_load_balancing.rst index e25ea45979..fef3eb71df 100644 --- a/source/adminguide/networking/global_server_load_balancing.rst +++ b/source/adminguide/networking/global_server_load_balancing.rst @@ -12,7 +12,7 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + Global Server Load Balancing Support ------------------------------------ @@ -32,6 +32,11 @@ provider the GSLB service. Currently, NetScaler is the supported GSLB provider in CloudStack. GSLB functionality works in an Active-Active data center environment. +.. note:: + Global Server Load Balancing is currently not supported in the new UI. + To manage Global Server Load Balancing, please directly invoke the + respective APIs or use `cloudmonkey `_, + the CLI tool for cloudstack About Global Server Load Balancing ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -193,13 +198,13 @@ above, the administrator of xyztelco is the one who sets up GSLB: tenant's cloud that make use of the GSLB service. #. On the NetScaler side, configure GSLB as given in `Configuring Global - Server Load Balancing (GSLB) + Server Load Balancing (GSLB) `_: #. Configuring a standard load balancing setup. #. Configure Authoritative DNS, as explained in `Configuring an - Authoritative DNS Service + Authoritative DNS Service `_. #. Configure a GSLB site with site name formed from the domain name @@ -211,17 +216,17 @@ above, the administrator of xyztelco is the one who sets up GSLB: As per the example given above, the site names are A.xyztelco.com and B.xyztelco.com. - For more information, see `Configuring a Basic GSLB Site + For more information, see `Configuring a Basic GSLB Site `_. #. Configure a GSLB virtual server. - For more information, see `Configuring a GSLB Virtual Server + For more information, see `Configuring a GSLB Virtual Server `_. #. Configure a GSLB service for each virtual server. - For more information, see `Configuring a GSLB Service + For more information, see `Configuring a GSLB Service `_. #. Bind the GSLB services to the GSLB virtual server. diff --git a/source/adminguide/networking/multiple_subnets_in_shared_network.rst b/source/adminguide/networking/multiple_subnets_in_shared_network.rst index 53b30bb8c4..c44c449d7d 100644 --- a/source/adminguide/networking/multiple_subnets_in_shared_network.rst +++ b/source/adminguide/networking/multiple_subnets_in_shared_network.rst @@ -12,7 +12,7 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + Multiple Subnets in Shared Network ---------------------------------- @@ -90,7 +90,11 @@ Adding Multiple Subnets to a Shared Network - **Start IP/ End IP**: A range of IP addresses that are accessible from the Internet and will be allocated to guest VMs. Enter the first and last IP addresses that define a range that CloudStack - can assign to guest VMs . + can assign to guest VMs. + + - **VLAN/VNI**: the ID or VID of the VLAN. If not specified, will be + defaulted to the vlan of the network or if vlan of the network is + null - to Untagged #. Click OK. diff --git a/source/adminguide/networking/remote_access_vpn.rst b/source/adminguide/networking/remote_access_vpn.rst index 85e43ed7ee..4c8413ba87 100644 --- a/source/adminguide/networking/remote_access_vpn.rst +++ b/source/adminguide/networking/remote_access_vpn.rst @@ -33,7 +33,7 @@ The VPN user database is shared across all the VPNs created by the account owner. All VPN users get access to all VPNs created by the account owner. -.. note:: +.. note:: Make sure that not all traffic goes through the VPN. That is, the route installed by the VPN should be only for the guest network and not for all traffic. @@ -85,7 +85,9 @@ To enable VPN for a particular network: #. Click one of the displayed IP address names. -#. Click the Enable VPN button. |vpn-icon.png| +#. Click the VPN Tab + +#. Click the Enable Remote Access VPN. |vpn-icon.png| The IPsec key is displayed in a popup window. diff --git a/source/adminguide/networking/site_to_site_vpn.rst b/source/adminguide/networking/site_to_site_vpn.rst index 3049396e0b..bb528e9985 100644 --- a/source/adminguide/networking/site_to_site_vpn.rst +++ b/source/adminguide/networking/site_to_site_vpn.rst @@ -26,7 +26,7 @@ The supported endpoints on the remote datacenters are: - CloudStack virtual routers -.. note:: +.. note:: In addition to the specific Cisco and Juniper devices listed above, the expectation is that any Cisco or Juniper device running on the supported operating systems are able to establish VPN connections. @@ -48,7 +48,7 @@ To set up a Site-to-Site VPN connection, perform the following: Creating and Updating a VPN Customer Gateway ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. note:: +.. note:: A VPN customer gateway can be connected to only one VPN gateway at a time. To add a VPN Customer Gateway: @@ -79,7 +79,7 @@ To add a VPN Customer Gateway: authenticate the customer gateway and the VPC VPN gateway to each other. The sequence cannot contain a newline or double-quote. - .. note:: + .. note:: The IKE peers (VPN end points) authenticate each other by computing and sending a keyed hash of data that includes the Preshared key. If the receiving peer is able to create the same @@ -92,7 +92,7 @@ To add a VPN Customer Gateway: AES256, and 3DES. Authentication is accomplished through the Preshared Keys. - .. note:: + .. note:: The phase-1 is the first phase in the IKE process. In this initial negotiation phase, the two VPN endpoints agree on the methods to be used to provide security for the underlying IP traffic. The @@ -112,7 +112,7 @@ To add a VPN Customer Gateway: within phase-2. The supported encryption algorithms are AES128, AES192, AES256, and 3DES. - .. note:: + .. note:: The phase-2 is the second phase in the IKE process. The purpose of IKE phase-2 is to negotiate IPSec security associations (SA) to set up the IPSec tunnel. In phase-2, new keying material is @@ -132,7 +132,7 @@ To add a VPN Customer Gateway: of the key exchanges increase as the DH groups grow larger, as does the time of the exchanges. - .. note:: + .. note:: When PFS is turned on, for every negotiation of a new phase-2 SA the two gateways must generate a new set of phase-1 keys. This adds an extra layer of protection that PFS adds, which ensures if @@ -154,6 +154,9 @@ To add a VPN Customer Gateway: regular intervals. It's recommended to have the same configuration of DPD on both side of VPN connection. + - **Force UDP Encapsulation of ESP Packets**: Force Encapsulation for + NAT traversal + #. Click OK. diff --git a/source/adminguide/networking/virtual_private_cloud_config.rst b/source/adminguide/networking/virtual_private_cloud_config.rst index 75042b2cea..d802d4093d 100644 --- a/source/adminguide/networking/virtual_private_cloud_config.rst +++ b/source/adminguide/networking/virtual_private_cloud_config.rst @@ -12,7 +12,7 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + .. _configuring-vpc: @@ -196,19 +196,19 @@ addresses in the form of a Classless Inter-Domain Routing (CIDR) block. - **Zone**: Choose the zone where you want the VPC to be available. - - **Super CIDR for Guest Networks**: Defines the CIDR range for all + - **CIDR**: Defines the CIDR range for all the tiers (guest networks) within a VPC. When you create a tier, ensure that its CIDR is within the Super CIDR value you enter. The CIDR must be RFC1918 compliant. - - **DNS domain for Guest Networks**: If you want to assign a special + - **Network Domain**: If you want to assign a special domain name, specify the DNS suffix. This parameter is applied to all the tiers within the VPC. That implies, all the tiers you create in the VPC belong to the same DNS domain. If the parameter is not specified, a DNS domain name is generated automatically. - - **Public Load Balancer Provider**: You have two options: VPC - Virtual Router and Netscaler. + - **VPC Offering**: If the administrator has configured multiple + VPC offerings, select the one you want to use for this VPC #. Click OK. @@ -231,7 +231,7 @@ other tiers within the VPC. All the VPC that you have created for the account is listed in the page. - .. note:: + .. note:: The end users can see their own VPCs, while root and domain admin can see any VPC they are authorized to see. @@ -428,7 +428,7 @@ Creating an ACL Rule are opening a single port, use the same number in both fields. - **Protocol Number**: The protocol number associated with IPv4 or - IPv6. For more information, see `Protocol Numbers + IPv6. For more information, see `Protocol Numbers `_. - **ICMP Type**, **ICMP Code** (ICMP only): The type of message and @@ -545,6 +545,8 @@ with duplicated VLAN and IP are allowed in the same data center. - **Physical Network**: The physical network you have created in the zone. + - **VLAN**: The VLAN associated with the VPC gateway. + - **IP Address**: The IP address associated with the VPC gateway. - **Gateway**: The gateway through which the traffic is routed to @@ -552,13 +554,14 @@ with duplicated VLAN and IP are allowed in the same data center. - **Netmask**: The netmask associated with the VPC gateway. - - **VLAN**: The VLAN associated with the VPC gateway. - - **Source NAT**: Select this option to enable the source NAT service on the VPC private gateway. See ":ref:`source-nat-priv-gw`". + - **Bypass VLAN id/range overlap**: Bypasses the check for a VLAN + overlap. This way multiple networks with the same VLAN can be created + - **ACL**: Controls both ingress and egress traffic on a VPC private gateway. By default, all the traffic is blocked. @@ -892,7 +895,7 @@ function only if they are defined on the default network. #. Click the IP you want to work with. -#. In the Details tab,click the Static NAT button. |enable-disable.png| +#. In the Details tab,click the Static NAT button. |enable-disable.png| The button toggles between Enable and Disable, depending on whether static NAT is currently enabled for the IP address. @@ -1101,7 +1104,7 @@ CloudStack supports sharing workload across different tiers within your VPC. Assume that multiple tiers are set up in your environment, such as Web tier and Application tier. Traffic to each tier is balanced on the VPC virtual router on the public side, as explained in -`"Adding Load Balancing Rules on a VPC" <#adding-load-balancing-rules-on-a-vpc>`_. +`"Adding Load Balancing Rules on a VPC" <#adding-load-balancing-rules-on-a-vpc>`_. If you want the traffic coming from the Web tier to the Application tier to be balanced, use the internal load balancing feature offered by CloudStack. @@ -1148,10 +1151,10 @@ Guidelines Enabling Internal LB on a VPC Tier '''''''''''''''''''''''''''''''''' -#. Create a network offering, as given in +#. Create a network offering, as given in :ref:`creating-net-offering-internal-lb`. -#. Create an internal load balancing rule and apply, as given in +#. Create an internal load balancing rule and apply, as given in :ref:`create-int-lb-rule`. diff --git a/source/adminguide/service_offerings.rst b/source/adminguide/service_offerings.rst index 6201215dd3..444200cfc1 100644 --- a/source/adminguide/service_offerings.rst +++ b/source/adminguide/service_offerings.rst @@ -13,7 +13,7 @@ specific language governing permissions and limitations under the License. -.. |update-service-offering-button.jpg| image:: /_static/images/update-service-offering-button.jpg +.. |update-service-offering-button.png| image:: /_static/images/update-service-offering-button.png :alt: Update offering access button .. |edit-icon.png| image:: /_static/images/edit-icon.png @@ -57,10 +57,10 @@ present users with choices when creating a new instance: creating a new instance. For example, CloudStack includes CentOS as a template. See Working with Templates. -In addition to these choices that are provided for users, there is +In addition to these choices that are provided for users, there is another type of service offering which is available only to the CloudStack -root administrator, and is used for configuring virtual infrastructure -resources. For more information, see Upgrading a Virtual Router with +root administrator, and is used for configuring virtual infrastructure +resources. For more information, see Upgrading a Virtual Router with System Service Offerings. Scope @@ -69,19 +69,19 @@ Scope Since version 4.13; compute offerings, disk offerings, network offerings and VPC offerings can be scoped to (made available in) combinations of specific domain(s) and zone(s) or to all domains and zones. -Existing offerings can be updated via the UI or via the updateServiceOffering, updateDiskOffering, +Existing offerings can be updated via the UI or via the updateServiceOffering, updateDiskOffering, updateNetworkOffering and updateVpcOffering API calls, by passing "domainid" and "zoneid" parameters. A root admin can change a domain-specific offering to a public one via the UI, or -by passing “domainid=public” in the updateServiceOffering API call. To make a -zone-specific offering available for all zones, a root admin should include +by passing “domainid=public” in the updateServiceOffering API call. To make a +zone-specific offering available for all zones, a root admin should include “zoneid=all” in the API call or carry out the operation via the UI. -Domain-admins have a limited scope to update service or compute offerings. They cannot -change the zone(s) in which the offerings are available, and they cannot change -the name, display text or sort-key for offerings. They can change the domain(s) -which an offering is available in, if the offering's scope is limited to only +Domain-admins have a limited scope to update service or compute offerings. They cannot +change the zone(s) in which the offerings are available, and they cannot change +the name, display text or sort-key for offerings. They can change the domain(s) +which an offering is available in, if the offering's scope is limited to only domains and/or subdomains for which the domain admin is the admin. @@ -102,13 +102,13 @@ offerings are predefined by the CloudStack administrator, in custom unconstraine offerings they are left undefined so that the end-user can enter their own desired values when creating a guest instance. Since 4.13 custom constrained offerings have been introduced to allow the end-user to enter the number of CPUs and memory -required within constraints set by the administrator. The constraints can be -different for different custom constrained offerings. This is useful to reduce +required within constraints set by the administrator. The constraints can be +different for different custom constrained offerings. This is useful to reduce the number of offerings the CloudStack administrator has to define; Instead of defining a compute offering for every imaginable combination of values that a user might want, the administrator can define offerings that provide some flexibility to the users and can serve as the basis for several -different VM configurations. +different VM configurations. A service offering includes the following elements: @@ -148,8 +148,8 @@ The disk offering specifies: - Tags on the data disk -To support the custom offerings, usage events register events for dynamically -assigned resources. Usage events are registered when a VM is created +To support the custom offerings, usage events register events for dynamically +assigned resources. Usage events are registered when a VM is created from a custom compute offering, and upon changing the compute offering of a stopped or running VM. The values of the parameters, such as CPU, speed, RAM are recorded. @@ -199,13 +199,13 @@ To create a new compute offering: - **Compute Offering Type**: The amount of freedom that the end user has to customise the compute power that their instance has when using this - compute offering. The options are; Fixed offering - user has no + compute offering. The options are; Fixed offering - user has no ability to customise, Custom constrained - user has some latitude - to customise the compute within parameters set by the offering, + to customise the compute within parameters set by the offering, Custom unconstrained - user can set any values that they wish 'Custom constrained' is recommended over 'Custom unconstrained' as it enables the admin to set some boundaries. - + - **# of CPU cores**: The number of cores which should be allocated to a system VM with this offering. If 'Custom constrained' is checked, the admin will be asked to enter the minimum and maximum number of CPUs that a user @@ -213,10 +213,10 @@ To create a new compute offering: field does not appear as the user will be prompted to enter a value when creating their guest instance. - **CPU (in MHz)**: The CPU speed of the cores that the guest instance is - allocated. For example, “2000” would provide a 2GHz CPU clock speed. + allocated. For example, “2000” would provide a 2GHz CPU clock speed. **This setting only used if CPU cap is selected.** This value is also passed to the hypervisor as a share value to give VMs - relative priority when a hypervisor host is over-provisioned. + relative priority when a hypervisor host is over-provisioned. If 'Custom unconstrained' is checked this field does not appear as the user will be prompted to enter a value when creating their guest instance. @@ -285,7 +285,7 @@ To create a new compute offering: available to all domains. Choose No to limit the scope to one or more specific domains. - - **isVolatile**: If checked, VMs created from this service offering + - **Volatile**: If checked, VMs created from this service offering will have their root disks reset upon reboot. This is useful for secure environments that need a fresh start on every boot and for desktops that should not retain state. @@ -326,12 +326,12 @@ To create a new compute offering: possible. Otherwise, the VM can be deployed in shared infrastructure. - **GPU**: Assign a physical GPU(GPU-passthrough) or a portion of a physical - GPU card (vGPU) to the guest VM. It allows graphical applications to run on the VM. + GPU card (vGPU) to the guest VM. It allows graphical applications to run on the VM. Select the card from the supported list of cards. The options given are NVIDIA GRID K1 and NVIDIA GRID K2. These are vGPU capable cards that allow multiple vGPUs on a single physical GPU. If you want to use a card other than these, follow the instructions in the - **"GPU and vGPU support for CloudStack Guest VMs"** page in the + **"GPU and vGPU support for CloudStack Guest VMs"** page in the Cloudstack Version 4.4 Design Docs found in the Cloudstack Wiki. - **vGPU Type**: Represents the type of virtual GPU to be assigned to a @@ -342,13 +342,13 @@ To create a new compute offering: In this case, a physical GPU device is exclusively allotted to a single guest VM. - - **Domain**: This is only visible When 'Public' is unchecked. When visible, this + - **Domain**: This is only visible When 'Public' is unchecked. When visible, this controls the domains which will be able to use this compute offering. A multi-selection - list box will be displayed. One or more domains can be selected from + list box will be displayed. One or more domains can be selected from this list box by holding down the control key and clicking on the desired domains. - - - **Zone**: This controls which zones a compute offering is available in. 'All zones' or - only specific zones can be selected. One or more zones can be selected from + + - **Zone**: This controls which zones a compute offering is available in. 'All zones' or + only specific zones can be selected. One or more zones can be selected from this list box by holding down the control key and clicking on the desired zones. - **Storage Policy**: Name of the storage policy defined at vCenter, this is applicable only for VMware. @@ -443,13 +443,13 @@ To create a new disk offering: available to all domains. Choose No to limit the scope to one or more specific domains. - - **Domain**: This is only visible When 'Public' is unchecked. When visible, this + - **Domain**: This is only visible When 'Public' is unchecked. When visible, this controls the domains which will be able to use this compute offering. A multi-selection - list box will be displayed. One or more domains can be selected from + list box will be displayed. One or more domains can be selected from this list box by holding down the control key and selecting the desired domains. - - **Zone**: This controls which zones a disk offering is available in. 'All zones' or - only specific zones can be selected. One or more zones can be selected from + - **Zone**: This controls which zones a disk offering is available in. 'All zones' or + only specific zones can be selected. One or more zones can be selected from this list box by holding down the control key and selecting the desired zones. - **Storage Policy**: Name of the storage policy defined at vCenter, this is applicable only for VMware. @@ -464,12 +464,12 @@ To create a new disk offering: Modifying or Deleting a Service Offering ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Service offerings cannot be materially changed once created. This applies to -both compute offerings and disk offerings. However their name, description +Service offerings cannot be materially changed once created. This applies to +both compute offerings and disk offerings. However their name, description and scope can be modified. To edit the name or description navigate to the -service offering's detail page and click on the edit icon |edit-icon.png|. +service offering's detail page and click on the edit icon |edit-icon.png|. To alter the scope (zones and domains) that an offering is available in -click on the update offering access button |update-service-offering-button.jpg|. +click on the update offering access button |update-service-offering-button.png|. A service offering can be deleted. If it is no longer in use, it is deleted immediately and permanently. If the service offering is still in diff --git a/source/adminguide/storage.rst b/source/adminguide/storage.rst index 9993c29db5..6feb481f9e 100644 --- a/source/adminguide/storage.rst +++ b/source/adminguide/storage.rst @@ -256,7 +256,7 @@ When creating a new volume from an existing ROOT volume snapshot, it is required to explicitly define a Disk offering (UI will offer only Disk offerings whose disk size is equal or bigger than the size of the snapshot). -|volume-from-snap.PNG| +|volume-from-snap.png| When creating a new volume from an existing DATA volume snapshot, the disk offering associated with the snapshots (inherited from the original volume) is assigned @@ -881,5 +881,5 @@ snapshot data. :alt: Detach Disk Button. .. |Migrateinstance.png| image:: /_static/images/migrate-instance.png :alt: button to migrate a volume. -.. |volume-from-snap.PNG| image:: /_static/images/volume-from-snap.PNG +.. |volume-from-snap.png| image:: /_static/images/volume-from-snap.png :alt: Offering is needed when creating a volume from the ROOT volume snapshot. diff --git a/source/adminguide/templates.rst b/source/adminguide/templates.rst index 615f520211..ab85f9c34f 100644 --- a/source/adminguide/templates.rst +++ b/source/adminguide/templates.rst @@ -171,10 +171,10 @@ as the prototype for other VMs. PV (32-bit) or Other PV (64-bit). This choice is available only for XenServere: - .. note:: - Generally you should not choose an older version of the OS - than the version in the image. For example, choosing CentOS - 5.4 to support a CentOS 6.2 image will in general not work. + .. note:: + Generally you should not choose an older version of the OS + than the version in the image. For example, choosing CentOS + 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other. .. note:: @@ -189,7 +189,7 @@ as the prototype for other VMs. Public Templates” <#private-and-public-templates>`_. - **Password Enabled**. Choose Yes if your template has the - CloudStack password change script installed. See + CloudStack password change script installed. See :ref:`adding-password-management-to-templates`. #. Click Add. @@ -203,15 +203,15 @@ available when creating a new VM. automatically at registration time. If a template contains different deployment options (or configurations) as in the case of virtual appliances, then CloudStack display the information required by the template, allowing users or administrators - to configure their instances. + to configure their instances. Creating a Template from a Snapshot ----------------------------------- If you do not want to stop the VM in order to use the Create Template -menu item (as described in `“Creating a Template from an Existing -Virtual Machine” <#creating-a-template-from-an-existing-virtual-machine>`_), -you can create a template directly from any snapshot through the +menu item (as described in `“Creating a Template from an Existing +Virtual Machine” <#creating-a-template-from-an-existing-virtual-machine>`_), +you can create a template directly from any snapshot through the CloudStack UI. @@ -222,7 +222,7 @@ Uploading Templates from a remote HTTP server vSphere Templates and ISOs ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. warning:: +.. warning:: If you are uploading a template that was created using vSphere Client, be sure the OVA file does not contain an ISO. If it does, the deployment of VMs from the template will fail @@ -249,6 +249,9 @@ To upload a template: available, or All Zones to make it available throughout CloudStack. + - **Bootable**. Select if this ISO is bootable. If not passed explicitly, + its assumed to be true. + - **OS Type**: (Except for VMware). This helps CloudStack and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following: @@ -257,10 +260,10 @@ To upload a template: - If the OS type of the stopped VM is not listed, choose Other. - .. note:: - You should not choose an older version of the OS than the - version in the image. For example, choosing CentOS 5.4 to - support a CentOS 6.2 image will in general not work. In + .. note:: + You should not choose an older version of the OS than the + version in the image. For example, choosing CentOS 5.4 to + support a CentOS 6.2 image will in general not work. In those cases you should choose Other. .. note:: @@ -274,10 +277,6 @@ To upload a template: - **Format**. The format of the template upload file, such as VHD or OVA. - - **Password Enabled**. Choose Yes if your template has the - CloudStack password change script installed. - See :ref:`adding-password-management-to-templates`. - - **Extractable**. Choose Yes if the template is available for extraction. If this option is selected, end users can download a full image of a template. @@ -291,10 +290,10 @@ To upload a template: more prominent for users to select. The template will appear in the Featured Templates list. Only an administrator can make a template Featured. - + Note that uploading multi-disk templates is also supported. -.. note:: +.. note:: VMware only: If the selected template contains OVF properties, different deployment options or configurations, multiple NICs or end-user license agreements, then the wizard will display these properties. @@ -311,7 +310,7 @@ Uploading Templates and ISOs from a local computer It's also possible to upload an already prepared template or an ISO from your local computer. The steps are similar as when Uploading a template/ISO from a remote HTTP server, except that you need to choose a local template/ISO file from your PC. -For this feature to work, your SSVMs must be supporting HTTPS (for more info please visit `“Using a SSL Certificate for the Console Proxy” +For this feature to work, your SSVMs must be supporting HTTPS (for more info please visit `“Using a SSL Certificate for the Console Proxy” `_). .. note:: @@ -321,7 +320,7 @@ For this feature to work, your SSVMs must be supporting HTTPS (for more info ple Example GUI dialog of uploading Template/ISO from local (browser) is given below: -|template-upload-from-local.PNG| +|template-upload-from-local.png| |upload-iso-from-local.png| @@ -330,7 +329,7 @@ Note that uploading multi-disk templates is also supported. Sharing templates and ISOs with other accounts/projects ---------------------------------------------- -When adding a template/ISO, the owner can choose to make template/ISO public or to keep it private. Once the template/ISO is created, the owner can choose to share this template/ISO so that other accounts/projects can also use the template/ISO. +When adding a template/ISO, the owner can choose to make template/ISO public or to keep it private. Once the template/ISO is created, the owner can choose to share this template/ISO so that other accounts/projects can also use the template/ISO. Currently, the owner can share his template/ISO with: - other accounts inside his own domain (i.e. can't share the template/ISO with other accounts in the subdomain of his domain or any other domains) @@ -338,48 +337,48 @@ Currently, the owner can share his template/ISO with: Template/ISO permissions can be changed via updateTemplatePermissions/updateIsoPermissions API call or via GUI. It is supported to add, remove or reset (remove all) template/ISO permissions. -When adding or removing permissions to/from a template/ISO, it is required to specify account/project name which is being added/removed from the template/ISO permissions. +When adding or removing permissions to/from a template/ISO, it is required to specify account/project name which is being added/removed from the template/ISO permissions. Global setting "allow.user.view.all.domain.accounts" has a default value of "false". This makes sure that when a regular user (of a "User" role) wants to share a template/ISO via GUI, he will not be shown the list of all accounts in his domain and he will need to know the name of the destination account with which he is sharing the template/ISO. This makes sense in public clouds where each account of a single domain is a different tenant/customer and privacy is imperative. In this case, the user will be presented with an input field to enter the account name, as on the images below: -.. warning:: +.. warning:: The images displayed below refer to template permissions, but the same applies for ISO permissions. -|template-permissions-update-manually-1.PNG| +|template-permissions-update-manually-1.png| Sharing the template with account "user2" -|template-permissions-update-manually-2.PNG| +|template-permissions-update-manually-2.png| Revoking permissions from account "user2" But in environments where privacy within a domain is not an issue, setting "allow.user.view.all.domain.accounts" setting to "true" will make sure that the user, who is sharing the template, will be presented a more user-friendly multi-select list, listing all the accounts in his domain. This is shown in the images below; -|template-permissions-update-1.PNG| +|template-permissions-update-1.png| Sharing the template with just account "user8" -|template-permissions-update-2.PNG| +|template-permissions-update-2.png| Sharing template with 2 specific projects -|template-permissions-update-3.PNG| +|template-permissions-update-3.png| Revoking permissions from account "user8" -|template-permissions-update-4.PNG| +|template-permissions-update-4.png| Revoking permissions from both projects previously added Finally, template permissions can be reset: -|template-permissions-update-5.PNG| +|template-permissions-update-5.png| Resetting (removing all) permissions -.. warning:: - Project-owned templates are not supported to be shared outside of +.. warning:: + Project-owned templates are not supported to be shared outside of the Project, and if attempted to do so, a proper error message is shown. Exporting Templates @@ -520,10 +519,10 @@ part of a template. - Red Hat Enterprise Linux 6 - .. note:: - It is not recommended to choose an older version of the OS than - the version in the image. For example, choosing CentOS 5.4 to - support a CentOS 6.2 image will usually not work. In these + .. note:: + It is not recommended to choose an older version of the OS than + the version in the image. For example, choosing CentOS 5.4 to + support a CentOS 6.2 image will usually not work. In these cases, choose Other. - **Extractable**: Choose Yes if the ISO should be available for @@ -573,19 +572,19 @@ Attaching an ISO to a VM .. |kvm-direct-download.png| image:: /_static/images/kvm-direct-download.png .. |upload-iso-from-local.png| image:: /_static/images/upload-iso-from-local.png :alt: Upload ISO from local -.. |template-upload-from-local.PNG| image:: /_static/images/template-upload-from-local.PNG +.. |template-upload-from-local.png| image:: /_static/images/template-upload-from-local.png :alt: Upload Template from local -.. |template-permissions-update-manually-1.PNG| image:: /_static/images/template-permissions-update-manually-1.PNG +.. |template-permissions-update-manually-1.png| image:: /_static/images/template-permissions-update-manually-1.png :alt: USharing template with account "user2" -.. |template-permissions-update-manually-2.PNG| image:: /_static/images/template-permissions-update-manually-2.PNG +.. |template-permissions-update-manually-2.png| image:: /_static/images/template-permissions-update-manually-2.png :alt: Revoking permissions from account "user2" -.. |template-permissions-update-1.PNG| image:: /_static/images/template-permissions-update-1.PNG +.. |template-permissions-update-1.png| image:: /_static/images/template-permissions-update-1.png :alt: Sharing template with just account "user8" -.. |template-permissions-update-2.PNG| image:: /_static/images/template-permissions-update-2.PNG +.. |template-permissions-update-2.png| image:: /_static/images/template-permissions-update-2.png :alt: Sharing template with 2 specific projects -.. |template-permissions-update-3.PNG| image:: /_static/images/template-permissions-update-3.PNG +.. |template-permissions-update-3.png| image:: /_static/images/template-permissions-update-3.png :alt: Revoking permissins from account "user8" -.. |template-permissions-update-4.PNG| image:: /_static/images/template-permissions-update-4.PNG +.. |template-permissions-update-4.png| image:: /_static/images/template-permissions-update-4.png :alt: Revoking permsissons from both projects previously added -.. |template-permissions-update-5.PNG| image:: /_static/images/template-permissions-update-5.PNG +.. |template-permissions-update-5.png| image:: /_static/images/template-permissions-update-5.png :alt: Reseting (removing all) permissions diff --git a/source/adminguide/troubleshooting.rst b/source/adminguide/troubleshooting.rst index e519257652..f4c0efceb1 100644 --- a/source/adminguide/troubleshooting.rst +++ b/source/adminguide/troubleshooting.rst @@ -12,7 +12,7 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + TroubleShooting =============== @@ -26,7 +26,7 @@ database activities for diagnostics purposes in messages. We recommend this command to find the problematic output in the Management Server log:. -.. note:: +.. note:: When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text. @@ -208,7 +208,7 @@ Solution See the following: -`VMware Knowledge Base Article +`VMware Knowledge Base Article `_ @@ -282,11 +282,11 @@ Trouble Shooting Steps .. image:: /_static/images/networking-zone-traffic-labels.png On an existing zone, you can modify the traffic labels by going to - *Infrastructure, Zones, Physical Network* tab. + *Infrastructure, Zones, Physical Network, Traffic Types* tab. .. image:: /_static/images/networking-infra-traffic-labels.png - List labels using *CloudMonkey* + List labels using *CloudMonkey* :: @@ -317,7 +317,7 @@ Trouble Shooting Steps traffictype = Storage xennetworklabel = MGMT ========================================================= - + #. KVM traffic labels require to be named as *"cloudbr0"*, *"cloudbr2"*, *"cloudbrN"* etc and the corresponding bridge must exist on the KVM hosts. If you create labels/bridges with any other names, CloudStack @@ -328,13 +328,13 @@ Trouble Shooting Steps :: kvm1 ~$ ifconfig cloudbr0 - cloudbr0 Link encap:Ethernet HWaddr 00:0C:29:EF:7D:78 + cloudbr0 Link encap:Ethernet HWaddr 00:0C:29:EF:7D:78 inet addr:192.168.44.22 Bcast:192.168.44.255 Mask:255.255.255.0 inet6 addr: fe80::20c:29ff:feef:7d78/64 Scope:Link UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1 RX packets:92435 errors:0 dropped:0 overruns:0 frame:0 TX packets:50596 errors:0 dropped:0 overruns:0 carrier:0 - collisions:0 txqueuelen:0 + collisions:0 txqueuelen:0 RX bytes:94985932 (90.5 MiB) TX bytes:61635793 (58.7 MiB) #. The Virtual Router, SSVM, CPVM *public* interface would be bridged to @@ -375,10 +375,10 @@ Trouble Shooting Steps :: - xenserver1 ~$ xe network-list + xenserver1 ~$ xe network-list uuid ( RO) : aaa-bbb-ccc-ddd name-label ( RW): MGMT - name-description ( RW): + name-description ( RW): bridge ( RO): xenbr0 @@ -451,6 +451,6 @@ Trouble Shooting Steps In a vast majority of the cases, the problem has turned out to be at the switching layer where the L3 switches were configured incorrectly. -This section was contibuted by Shanker Balan and was originally published on +This section was contibuted by Shanker Balan and was originally published on `Shapeblue's blog `_ diff --git a/source/adminguide/virtual_machines.rst b/source/adminguide/virtual_machines.rst index a02645b2ad..3d693634fa 100644 --- a/source/adminguide/virtual_machines.rst +++ b/source/adminguide/virtual_machines.rst @@ -12,7 +12,7 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + About Working with Virtual Machines =================================== @@ -36,9 +36,9 @@ names can be controlled by the user: - Name – host name that the DHCP server assigns to the VM. Can be set by the user. Defaults to instance name -.. note:: - You can append the display name of a guest VM to its internal name. - For more information, see `“Appending a Display Name to the Guest VM’s +.. note:: + You can append the display name of a guest VM to its internal name. + For more information, see `“Appending a Display Name to the Guest VM’s Internal Name” <#appending-a-display-name-to-the-guest-vms-internal-name>`_. Guest VMs can be configured to be Highly Available (HA). An HA-enabled @@ -117,10 +117,10 @@ create blank virtual machines. A blank virtual machine is a virtual machine without an OS template. Users can attach an ISO file and install the OS from the CD/DVD-ROM. -.. note:: - You can create a VM without starting it. You can determine whether the - VM needs to be started as part of the VM deployment. A request parameter, - startVM, in the deployVm API provides this feature. For more information, +.. note:: + You can create a VM without starting it. You can determine whether the + VM needs to be started as part of the VM deployment. A request parameter, + startVM, in the deployVm API provides this feature. For more information, see the Developer's Guide. To create a VM from a template: @@ -140,7 +140,7 @@ To create a VM from a template: #. Be sure that the hardware you have allows starting the selected service offering. - .. note:: + .. note:: VMware only: If the selected template contains OVF properties, different deployment options or configurations, multiple NICs or end-user license agreements, then the wizard will display these properties. @@ -148,19 +148,19 @@ To create a VM from a template: #. Click Submit and your VM will be created and started. - .. note:: - For security reason, the internal name of the VM is visible + .. note:: + For security reason, the internal name of the VM is visible only to the root admin. To create a VM from an ISO: -.. note:: - **XenServer** +.. note:: + **XenServer** - Windows VMs running on XenServer require PV drivers, - which may be provided in the template or added after the VM is - created. The PV drivers are necessary for essential management - functions such as mounting additional volumes and ISO images, + Windows VMs running on XenServer require PV drivers, + which may be provided in the template or added after the VM is + created. The PV drivers are necessary for essential management + functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown. #. Log in to the CloudStack UI as an administrator or user. @@ -248,14 +248,14 @@ Once a VM instance is created, you can stop, restart, or delete it as needed. In the CloudStack UI, click Instances, select the VM, and use the Stop, Start, Reboot, and Destroy buttons. -A stop will attempt to gracefully shut down the operating system, via +A stop will attempt to gracefully shut down the operating system, via an ACPI 'stop' command which is similar to pressing the soft power switch on a physical server. If the operating system cannot be stopped, it will be forcefully terminated. This has the same effect as pulling out the power cord from a physical machine. A reboot should not be considered as a stop followed by a start. In CloudStack, -a start command reconfigures the virtual machine to the stored parameters in +a start command reconfigures the virtual machine to the stored parameters in CloudStack's database. The reboot process does not do this. When starting a VM, admin users have the option to specify a pod, cluster, or host. @@ -281,14 +281,14 @@ To delete a virtual machine: #. Optionally both expunging and the deletion of any attached volumes can be enabled. When a virtual machine is **destroyed**, it can no longer be seen by the end user, -however, it can be seen (and recovered) by a root admin. In this state it still +however, it can be seen (and recovered) by a root admin. In this state it still consumes logical resources. Global settings control the maximum time from a VM being destroyed, to the physical disks being removed. When the VM and its rooot disk have been deleted, the VM is said to have been expunged. Once a virtual machine is **expunged**, it cannot be recovered. All the resources used by the virtual machine will be reclaimed by the system, -This includes the virtual machine’s IP address. +This includes the virtual machine’s IP address. Managing Virtual Machines ========================= @@ -549,14 +549,14 @@ To manually live migrate a virtual machine #. From the list of suitable hosts, choose the one to which you want to move the VM. - .. note:: - If the VM's storage has to be migrated along with the VM, this will - be noted in the host list. CloudStack will take care of the storage + .. note:: + If the VM's storage has to be migrated along with the VM, this will + be noted in the host list. CloudStack will take care of the storage migration for you. #. Click OK. -.. note:: +.. note:: (KVM) If the VM's storage has to be migrated along with the VM, from a mounted NFS storage pool to a cluster-wide mounted NFS storage pool, then the 'migrateVirtualMachineWithVolume' API has to be used. There is no UI integration for this feature. (CloudMonkey) > migrate virtualmachinewithvolume virtualmachineid= hostid= migrateto[i].volume= migrateto[i].pool= @@ -658,8 +658,8 @@ Assign a New VM to an Affinity Group To assign a new VM to an affinity group: - Create the VM as usual, as described in `“Creating - VMs” `_. In the Add Instance - wizard, there is a new Affinity tab where you can select the + VMs” `_. In the Add Instance + wizard, there is a new Affinity tab where you can select the affinity group. @@ -748,9 +748,9 @@ already in use by the VM. Advanced VM Instance Settings ----------------------------- -Each user VM has a set of "details" associated with it (as visible via listVirtualMachine API call) - those "details" are shown on the "Settings" tab of the VM in the GUI (words "setting(s)" and "detail(s)" are here used interchangeably). +Each user VM has a set of "details" associated with it (as visible via listVirtualMachine API call) - those "details" are shown on the "Settings" tab of the VM in the GUI (words "setting(s)" and "detail(s)" are here used interchangeably). -The Settings tab is always present/visible, but settings can be changed only when the VM is in a Stopped state. +The Settings tab is always present/visible, but settings can be changed only when the VM is in a Stopped state. Some VM details/settings can be hidden via "user.vm.blacklisted.details" global setting (you can find below the list of those hidden by default). .. note:: @@ -761,22 +761,22 @@ When adding a new setting or modifying the existing ones, setting names are show Read-only details/settings that are hidden by default: - rootdisksize -- cpuOvercommitRatio -- memoryOvercommitRatio +- cpuOvercommitRatio +- memoryOvercommitRatio - Message.ReservedCapacityFreed.Flag An example list of settings as well as their possible values are shown on the images below: -|vm-settings-dropdown-list.PNG| +|vm-settings-dropdown-list.png| (VMware hypervisor) -|vm-settings-values-dropdown-list.PNG| +|vm-settings-values-dropdown-list.png| (VMware disk controllers) -|vm-settings-values1-dropdown-list.PNG| +|vm-settings-values1-dropdown-list.png| (VMware NIC models) -|vm-settings-values-dropdown-KVM-list.PNG| +|vm-settings-values-dropdown-KVM-list.png| (KVM disk controllers) @@ -817,7 +817,7 @@ to write RAM memory content anywhere. If you need more information about VM snapshots on VMware, check out the VMware documentation and the VMware Knowledge Base, especially -`Understanding virtual machine snapshots +`Understanding virtual machine snapshots `_. @@ -872,8 +872,8 @@ To create a VM snapshot using the CloudStack UI: #. Click the Take VM Snapshot button. |VMSnapshotButton.png| - .. note:: - If a snapshot is already in progress, then clicking this button + .. note:: + If a snapshot is already in progress, then clicking this button will have no effect. #. Provide a name and description. These will be displayed in the VM @@ -913,8 +913,8 @@ snapshot: To revert to the snapshot, click the Revert button. |revert-vm.png| -.. note:: - VM snapshots are deleted automatically when a VM is destroyed. You don't +.. note:: + VM snapshots are deleted automatically when a VM is destroyed. You don't have to manually delete the snapshots in this case. Support for Virtual Appliances @@ -961,8 +961,8 @@ Create an instance template that supports SSH Keys. For more information on creating a new instance, see -#. Download the cloudstack script from `The SSH Key Gen Script - `_ +#. Download the cloudstack script from `The SSH Key Gen Script + `_ to the instance you have created. .. parsed-literal:: @@ -1000,9 +1000,9 @@ call to the cloudstack api. For example, make a call from the cloudstack server to create a SSH keypair called "keypair-doc" for the admin account in the root domain: -.. note:: - Ensure that you adjust these values to meet your needs. If you are - making the API call from a different server, your URL/PORT will be +.. note:: + Ensure that you adjust these values to meet your needs. If you are + making the API call from a different server, your URL/PORT will be different, and you will need to use the API keys. #. Run the following curl command: @@ -1058,8 +1058,8 @@ Instance Template that Supports SSH Keys” <#create-ssh-template>`__. Ensure that you use the same SSH key name that you created at `Section 5.2.2, “Creating the SSH Keypair” <#create-ssh-keypair>`__. -.. note:: - You cannot create the instance by using the GUI at this time and +.. note:: + You cannot create the instance by using the GUI at this time and associate the instance with the newly created SSH keypair. A sample curl command to create a new instance is: @@ -1162,10 +1162,10 @@ Before proceeding, ensure that you have these prerequisites: - The vGPU-enabled XenServer 6.2 and later versions. For more information, see `Citrix 3D Graphics Pack `_. - + - GPU/vPGU functionality is supported for following HVM guest operating systems: For more information, see `Citrix 3D Graphics Pack `_. - + - Windows 7 (x86 and x64) - Windows Server 2008 R2 @@ -1235,30 +1235,30 @@ CloudStack follows the below sequence of operations to provide GPU/vGPU support #. Add the host to CloudStack. CloudStack checks if the host is GPU-enabled or not. CloudStack queries the host and detect if it's GPU enabled. - + #. Create a compute offering with GPU/vGPU support: For more information, see `Creating a New Compute Offering <#creating-a-new-compute-offering>`__.. #. Continue with any of the following operations: - + - Deploy a VM. - + Deploy a VM with GPU/vGPU support by selecting appropriate Service Offering. CloudStack decide which host to choose for VM deployment based on following criteria: - + - Host has GPU cards in it. In case of vGPU, CloudStack checks if cards have the required vGPU type support and enough capacity available. Having no appropriate hosts results in an InsufficientServerCapacity exception. - - - Alternately, you can choose to deploy a VM without GPU support, and at a later point, you can change the system offering. You can achieve this by offline upgrade: stop the VM, upgrade the Service Offering to the one with vGPU, then start the VM. + + - Alternately, you can choose to deploy a VM without GPU support, and at a later point, you can change the system offering. You can achieve this by offline upgrade: stop the VM, upgrade the Service Offering to the one with vGPU, then start the VM. In this case, CloudStack gets a list of hosts which have enough capacity to host the VM. If there is a GPU-enabled host, CloudStack reorders this host list and place the GPU-enabled hosts at the bottom of the list. - + - Migrate a VM. - + CloudStack searches for hosts available for VM migration, which satisfies GPU requirement. If the host is available, stop the VM in the current host and perform the VM migration task. If the VM migration is successful, the remaining GPU capacity is updated for both the hosts accordingly. - + - Destroy a VM. - + GPU resources are released automatically when you stop a VM. Once the destroy VM is successful, CloudStack will make a resource call to the host to get the remaining GPU capacity in the card and update the database accordingly. - + .. |vm-lifecycle.png| image:: /_static/images/vm-lifecycle.png :alt: Virtual Machine State Model .. |VMSnapshotButton.png| image:: /_static/images/VMSnapshotButton.png @@ -1282,11 +1282,11 @@ CloudStack follows the below sequence of operations to provide GPU/vGPU support :alt: depicts adding an iso image .. |StopButton.png| image:: /_static/images/stop-instance-icon.png :alt: depicts adding an iso image -.. |vm-settings-dropdown-list.PNG| image:: /_static/images/vm-settings-dropdown-list.PNG +.. |vm-settings-dropdown-list.png| image:: /_static/images/vm-settings-dropdown-list.png :alt: List of possible VMware settings -.. |vm-settings-values-dropdown-list.PNG| image:: /_static/images/vm-settings-values-dropdown-list.PNG +.. |vm-settings-values-dropdown-list.png| image:: /_static/images/vm-settings-values-dropdown-list.png :alt: List of possible VMware disk controllers -.. |vm-settings-values1-dropdown-list.PNG| image:: /_static/images/vm-settings-values1-dropdown-list.PNG +.. |vm-settings-values1-dropdown-list.png| image:: /_static/images/vm-settings-values1-dropdown-list.png :alt: List of possible VMware NIC models -.. |vm-settings-values-dropdown-KVM-list.PNG| image:: /_static/images/vm-settings-values-dropdown-KVM-list.PNG +.. |vm-settings-values-dropdown-KVM-list.png| image:: /_static/images/vm-settings-values-dropdown-KVM-list.png :alt: List of possible KVM disk controllers diff --git a/source/developersguide/plugins.rst b/source/developersguide/plugins.rst index 7773bfe339..72d16ee798 100644 --- a/source/developersguide/plugins.rst +++ b/source/developersguide/plugins.rst @@ -76,7 +76,7 @@ steps (explained in more detail later in this section): #. Hardcode your plugin's required additional input fields into the code for the Add Secondary Storage or Add Primary Storage dialog box. -#. Place your .jar file in `plugins/storage/volume/` or +#. Place your .jar file in `plugins/storage/volume/` or `plugins/storage/image/`. #. Edit `/client/tomcatconf/componentContext.xml.in`. @@ -350,7 +350,7 @@ placed in a special directory within CloudStack’s installed code at any time after CloudStack installation. The new plugin appears only when it is enabled by the cloud administrator. -.. figure:: /_static/images/plugin_intro.jpg +.. figure:: /_static/images/plugin_intro.png :align: center :alt: New plugin button in CloudStack navbar @@ -383,8 +383,8 @@ The basic procedure for writing a plugin is: +-- icon.png --> Icon, shown on side nav bar and plugin listing (should be square, and ~50x50px) +-- csMyFirstPlugin.css --> CSS file, loaded automatically when plugin loads - +-- csMyFirstPlugin.js --> Main JS file, containing plugin code - + +-- csMyFirstPlugin.js --> Main JS file, containing plugin code + The same files must also be present at `/tomcat/webapps/client/plugins`. @@ -406,7 +406,7 @@ The basic procedure for writing a plugin is: #. The next time the user refreshes the UI in the browser, your plugin will appear in the left navigation bar. - .. figure:: /_static/images/plugin4.jpg + .. figure:: /_static/images/plugin4.png :align: center :alt: The plugin appears in the UI @@ -444,13 +444,13 @@ Plugins are written in a very similar way to the main UI. total 8 drwxr-xr-x 2 bgregory staff 68 Feb 11 14:44 csMyFirstPlugin -rw-r--r-- 1 bgregory staff 101 Feb 11 14:26 plugins.js - + #. **Change to your new plugin directory.** :: $ cd csMyFirstPlugin - + #. **Set up the listing.** Add the file `config.js`, using your favorite editor. @@ -472,8 +472,8 @@ Plugins are written in a very similar way to the main UI. authorName: 'Test Plugin Developer', authorEmail: 'plugin.developer@example.com' }; - }(cloudStack)); - + }(cloudStack)); + #. **Add a new main section.** @@ -500,8 +500,8 @@ Plugins are written in a very similar way to the main UI. } }); }; - }(cloudStack)); - + }(cloudStack)); + #. **Register the plugin.** @@ -512,8 +512,8 @@ Plugins are written in a very similar way to the main UI. :: $ cd cloudstack/ui/plugins - $ vi plugins.js - + $ vi plugins.js + Now add the following to plugins.js: @@ -523,8 +523,8 @@ Plugins are written in a very similar way to the main UI. cloudStack.plugins = [ 'csMyFirstPlugin' ]; - }(jQuery, cloudStack)); - + }(jQuery, cloudStack)); + #. **Check the plugin in the UI.** @@ -552,8 +552,8 @@ Plugins are written in a very similar way to the main UI. :: $ cd csMyFirstPlugin - $ vi csMyFirstPlugin.js - + $ vi csMyFirstPlugin.js + Add the following code in csMyFirstPlugin.js: @@ -596,8 +596,8 @@ Plugins are written in a very similar way to the main UI. } }); }; - }(cloudStack)); - + }(cloudStack)); + #. **Test the plugin.** @@ -615,8 +615,8 @@ Plugins are written in a very similar way to the main UI. :: - $ vi csMyFirstPlugin.js - + $ vi csMyFirstPlugin.js + Now add the following new code in csMyFirstPlugin.js. (The dots ... show where we have omitted some existing code for the sake of space. @@ -648,7 +648,7 @@ Plugins are written in a very similar way to the main UI. // Get the instance object of the selected row from context // // -- all currently loaded state is stored in 'context' as objects, - // such as the selected list view row, + // such as the selected list view row, // the selected section, and active user // // -- for list view actions, the object's key will be the same as @@ -676,8 +676,8 @@ Plugins are written in a very similar way to the main UI. _custom: { jobId: json.rebootvirtualmachineresponse.jobid } }); }, - - + + error: function(errorMessage) { args.response.error(errorMessage); // Cancel action, show error message returned } @@ -700,8 +700,8 @@ Plugins are written in a very similar way to the main UI. dataProvider: function(args) { ... - ... - + ... + #. **Add the thumbnail icon.** @@ -716,8 +716,8 @@ Plugins are written in a very similar way to the main UI. `cloudstack/ui/plugins/csMyFirstPlugin/csMyFirstPlugin.css`. -.. | plugin_intro.jpg: New plugin button in CloudStack navbar | image:: _static/images/plugin_intro.jpg +.. | plugin_intro.png: New plugin button in CloudStack navbar | image:: _static/images/plugin_intro.png .. | plugin1.jpg: Write the plugin code | image:: _static/images/plugin1.jpg .. | plugin2.jpg: The plugin code is placed in the PLUGINS folder | image:: _static/images/plugin2.jpg .. | plugin3.jpg: The plugin name is added to plugin.js in the PLUGINS folder | image:: _static/images/plugin3.jpg -.. | plugin4.jpg: The plugin appears in the UI | image:: _static/images/plugin4.jpg +.. | plugin4.png: The plugin appears in the UI | image:: _static/images/plugin4.png diff --git a/source/installguide/configuration.rst b/source/installguide/configuration.rst index 89123c31a1..1146ff2920 100644 --- a/source/installguide/configuration.rst +++ b/source/installguide/configuration.rst @@ -316,11 +316,11 @@ Basic Zone Configuration .. cssclass:: table-striped table-bordered table-hover =============================================== =================================================================================================================== - Network Offering Description + Network Offering Description =============================================== =================================================================================================================== DefaultSharedNetworkOfferingWithSGService If you want to enable security groups for guest traffic isolation, choose this. (See Using Security Groups to Control Traffic to VMs.) DefaultSharedNetworkOffering If you do not need security groups, choose this. - DefaultSharedNetscalerEIPandELBNetworkOffering If you have installed a Citrix NetScaler appliance as part of your zone network, and you will be using its Elastic IP and Elastic Load Balancing features, choose this. With the EIP and ELB features, a basic zone with security groups enabled can offer 1:1 static NAT and load balancing. + DefaultSharedNetscalerEIPandELBNetworkOffering If you have installed a Citrix NetScaler appliance as part of your zone network, and you will be using its Elastic IP and Elastic Load Balancing features, choose this. With the EIP and ELB features, a basic zone with security groups enabled can offer 1:1 static NAT and load balancing. =============================================== =================================================================================================================== @@ -548,8 +548,8 @@ Advanced Zone Configuration The traffic types are management, public, guest, and storage traffic. For more information about the types, roll over the icons to display their tool tips, or see :ref:`about-adv-network-traffic-types`. - This screenstarts out with one network already configured. If you have - multiple physical networks, you need to add more. Drag and drop traffic + This screenstarts out with one network already configured. If you have + multiple physical networks, you need to add more. Drag and drop traffic types onto a greyed-out network and it will become active. You can move the traffic icons from one network to another; for example, if the default traffic types shown for Network 1 do not match your actual @@ -874,77 +874,20 @@ To add a vSphere cluster to CloudStack: - **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 CloudStack should use to connect to vCenter. This user must have all the administrative privileges. - - **CPU overcommit ratio**: Enter the CPU overcommit ratio for the - cluster. The value you enter determines the CPU consumption of - each VM in the selected cluster. By increasing the - over-provisioning ratio, more resource capacity will be used. If - no value is specified, the value is defaulted to 1, which implies - no over-provisioning is done. - - - **RAM overcommit ratio**: Enter the RAM overcommit ratio for the - cluster. The value you enter determines the memory consumption of - each VM in the selected cluster. By increasing the - over-provisioning ratio, more resource capacity will be used. If - no value is specified, the value is defaulted to 1, which implies - no over-provisioning is done. - - - **vCenter Host**: Enter the hostname or IP address of the vCenter - server. - - **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". - - **Override Public Traffic**: Enable this option to override the - zone-wide public traffic for the cluster you are creating. - - - **Public Traffic vSwitch Type**: This option is displayed only if - you enable the Override Public Traffic option. Select a desirable - switch. If the vmware.use.dvswitch global parameter is true, the - default option will be VMware vNetwork Distributed Virtual Switch. - - 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 appliance. - - - Nexus dvSwitch Password: The password associated with the - username specified above. - - - **Override Guest Traffic**: Enable this option to override the - zone-wide guest traffic for the cluster you are creating. - - - **Guest Traffic vSwitch Type**: This option is displayed only if - you enable the Override Guest Traffic option. Select a desirable - switch. - - If the vmware.use.dvswitch global parameter is true, the default - option will be VMware vNetwork Distributed Virtual Switch. - - 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 appliance. - - - Nexus dvSwitch Password: The password associated with the - username specified above. - - - There might be a slight delay while the cluster is provisioned. It - will automatically display in the UI. - + - **Dedicated**: When marked as dedicated, this device will be dedicated + to a single account. .. _adding-a-host: @@ -963,8 +906,8 @@ Adding a Host hypervisor hosts for use with CloudStack. .. warning:: - Be sure you have performed the additional CloudStack-specific - configuration steps described in the hypervisor installation section for + Be sure you have performed the additional CloudStack-specific + configuration steps described in the hypervisor installation section for your particular hypervisor. #. Now add the hypervisor host to CloudStack. The technique to use @@ -987,7 +930,7 @@ Requirements for XenServer and KVM Hosts ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. warning:: - Make sure the hypervisor host does not have any VMs already running before + Make sure the hypervisor host does not have any VMs already running before you add it to CloudStack. Configuration requirements: @@ -1016,9 +959,9 @@ pool. # xe pool-join master-address=[master IP] master-username=root master-password=[your password] -.. note:: - When copying and pasting a command, be sure the command has pasted as a - single line before executing. Some document viewers may introduce unwanted +.. note:: + When copying and pasting a command, be sure the command has pasted as a + single line before executing. Some document viewers may introduce unwanted line breaks in copied text. With all hosts added to the XenServer pool, run the cloud-setup-bond @@ -1149,9 +1092,9 @@ of that procedure. You can add primary storage servers at any time, such as when adding a new cluster or adding more servers to an existing cluster. -.. warning:: - When using preallocated storage for primary storage, be sure there is - nothing on the storage (ex. you have an empty SAN volume or an empty NFS +.. warning:: + When using preallocated storage for primary storage, be sure there is + nothing on the storage (ex. you have an empty SAN volume or an empty NFS share). Adding the storage to CloudStack will destroy any existing data. #. Log in to the CloudStack UI :ref:`log-in-to-ui`. @@ -1252,15 +1195,15 @@ Configuring a Storage Plug-in ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. note:: - Primary storage that is based on a custom plug-in (ex. SolidFire) must be - added through the CloudStack API (described later in this section). There - is no support at this time through the CloudStack UI to add this type of + Primary storage that is based on a custom plug-in (ex. SolidFire) must be + added through the CloudStack API (described later in this section). There + is no support at this time through the CloudStack UI to add this type of primary storage (although most of its features are available through the CloudStack UI). .. note:: - The SolidFire storage plug-in for CloudStack is part of the standard - CloudStack install. There is no additional work required to add this + The SolidFire storage plug-in for CloudStack is part of the standard + CloudStack install. There is no additional work required to add this component. Adding primary storage that is based on the SolidFire plug-in enables @@ -1355,7 +1298,7 @@ of that procedure. You can add secondary storage servers at any time to add more servers to an existing zone. .. warning:: - Ensure that nothing is stored on the server. Adding the server to + Ensure that nothing is stored on the server. Adding the server to CloudStack will destroy any existing data. #. To prepare for the zone-based Secondary Staging Store, you should @@ -1366,7 +1309,7 @@ add more servers to an existing zone. share. #. Make sure you prepared the system VM template during Management - Server installation. See `“Prepare the System VM Template” + Server installation. See `“Prepare the System VM Template” `_. #. Log in to the CloudStack UI as root administrator. @@ -1389,16 +1332,16 @@ add more servers to an existing zone. For Hyper-V, select SMB/CIFS. .. warning:: - Heterogeneous Secondary Storage is not supported in Regions. You can + Heterogeneous Secondary Storage is not supported in Regions. You can use only a single NFS, S3, or Swift account per region. - Create NFS Secondary Staging Store. This box must always be checked. - .. warning:: - Even if the UI allows you to uncheck this box, do not do so. This - checkbox and the three fields below it must be filled in. Even when - Swift or S3 is used as the secondary storage provider, an NFS staging + .. warning:: + Even if the UI allows you to uncheck this box, do not do so. This + checkbox and the three fields below it must be filled in. Even when + Swift or S3 is used as the secondary storage provider, an NFS staging storage in each zone is still required. - Zone. The zone where the NFS Secondary Staging Store is to be @@ -1636,7 +1579,7 @@ zone router.template.vmware Name of the zone enable.dynamic.scale.vm Enable or diable dynamically scaling of a VM. zone use.external.dns Bypass internal DNS, and use the external DNS1 and DNS2 zone blacklisted.routes Routes that are blacklisted cannot be used for creating static routes for a VPC Private Gateway. -======== ========================================================= ====================================================================================================================================== +======== ========================================================= ====================================================================================================================================== .. |provisioning-overview.png: Conceptual overview of a basic deployment| image:: /_static/images/provisioning-overview.png diff --git a/source/plugins/index.rst b/source/plugins/index.rst index fe953330a8..783e4f4399 100644 --- a/source/plugins/index.rst +++ b/source/plugins/index.rst @@ -32,7 +32,6 @@ This is the Apache CloudStack Plugins guide. This section gives information for cloudian-connector nicira-plugin - nuage-plugin vxlan ovs-plugin ipv6 diff --git a/source/plugins/nuage-plugin.rst b/source/plugins/nuage-plugin.rst deleted file mode 100644 index 38eda79024..0000000000 --- a/source/plugins/nuage-plugin.rst +++ /dev/null @@ -1,513 +0,0 @@ -.. 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. - - -The Nuage VSP Plugin -==================== - - -Introduction ------------- - -The Nuage VSP Plugin is the Nuage Networks SDN -implementation in CloudStack, which integrates with Nuage Networks -Virtualized Services Platform (VSP). -The plugin can be used by CloudStack to leverage the scalability and rich features of advanced SDN being provided by the Nuage VSP SDN Platform and to implement: - -* Isolated Guest Networks -* Virtual Private Clouds (VPC) -* Shared Networks - -For more information about Nuage Networks, visit www.nuagenetworks.net. - -Supported Features -~~~~~~~~~~~~~~~~~~ - -The following table lists the supported Network services in a CloudStack deployment with NuageVsp being the Connectivity/Virtual Networking provider, with their providers and supported CloudStack versions. - -.. cssclass:: table-striped table-bordered table-hover - -+---------------------------+---------------------------+---------------------------+---------------------------+ -| Network Service | Isolated Networks | VPCs | Shared Networks | -+===========================+===========================+===========================+===========================+ -| Virtual Networking | NuageVsp (>=4.5) | NuageVsp (>=4.5) | NuageVsp (>=4.10) | -+---------------------------+---------------------------+---------------------------+---------------------------+ -| Dhcp | NuageVsp (>=4.5) | NuageVsp (>=4.5) | NuageVsp (>=4.10) | -+---------------------------+---------------------------+---------------------------+---------------------------+ -| SourceNat | NuageVsp (>=4.10) | NuageVsp (>=4.10) | N/A | -+---------------------------+---------------------------+---------------------------+---------------------------+ -| StaticNat | NuageVsp (>=4.5) | NuageVsp (>=4.5) | N/A | -+---------------------------+---------------------------+---------------------------+---------------------------+ -| Firewall | NuageVsp (>=4.5) | N/A | N/A | -+---------------------------+---------------------------+---------------------------+---------------------------+ -| NetworkACL | N/A | NuageVsp (>=4.5) | N/A | -+---------------------------+---------------------------+---------------------------+---------------------------+ -| UserData | VirtualRouter (>=4.5) | VpcVirtualRouter (>=4.5) | VirtualRouter (>=4.10) | -+---------------------------+---------------------------+---------------------------+---------------------------+ -| Dns | VirtualRouter (>=4.10) | VpcVirtualRouter (>=4.10) | N/A | -+---------------------------+---------------------------+---------------------------+---------------------------+ -| Internal Lb | N/A | InternalLbVm (>=4.9) | N/A | -+---------------------------+---------------------------+---------------------------+---------------------------+ - -Table: Supported Network Services - -.. note:: - The Virtual Networking service was originally called 'Connectivity' - in CloudStack 4.0 - -Supported Hypervisors -~~~~~~~~~~~~~~~~~~~~~ - -The following hypervisors are supported by the Nuage VSP Plugin, with their supported CloudStack versions. - -.. cssclass:: table-striped table-bordered table-hover - -+----------------------+----------------------+ -| Hypervisor | CloudStack version | -+======================+======================+ -| KVM 7.x | >= 4.5 | -+----------------------+----------------------+ -| VMware ESXi 5.5 | >= 4.5 | -+----------------------+----------------------+ -| VMware ESXi 6.0 | >= 4.9 | -+----------------------+----------------------+ - -Table: Supported Hypervisors - -Supported Nuage VSP SDN Platform Versions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following Nuage VSP SDN Platform versions are supported by the Nuage VSP Plugin, with their supported CloudStack versions. - -.. cssclass:: table-striped table-bordered table-hover - -+----------------------+----------------------+ -| Nuage VSP version | CloudStack version | -+======================+======================+ -| Nuage VSP v3.2 | >= 4.5 | -+----------------------+----------------------+ -| Nuage VSP v4.0 | >= 4.10 | -+----------------------+----------------------+ - -Table: Supported Nuage VSP SDN Platform Versions - - -Configuring The Nuage VSP Plugin --------------------------------- - -Prerequisites -~~~~~~~~~~~~~ - -Before enabling and using the Nuage VSP Plugin with CloudStack. - -1. Verify that the CloudStack deployment (hypervisors) and Nuage VSP SDN Platform version you intend to use is being supported. - -.. Note:: Only the release notes for Nuage VSP contain the most up-to-date information on different supported versions. Please check them to verify that the information in this document is up-to-date. - -2. Prepare and configure the hypervisors for CloudStack integration with Nuage VSP SDN Platform. - -.. note:: - Please refer to the Nuage VSP Install Guide on how to prepare the hypervisors for Nuage VSP SDN Platform integration. - -Required Nuage VSD Configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -When configuring Nuage VSP as the network service provider in a CloudStack Zone, a CSP user must be added in Nuage VSD, and this user must be added to the CMS group. See `Enable Nuage VSP Network Service Provider`_. - -.. note:: - Nuage VSD is the programmable policy and analytics engine of the Nuage VSP SDN Platform with which the Nuage VSP Plugin interacts. - -Zone Configuration -~~~~~~~~~~~~~~~~~~ - -Select VSP Isolation Method -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Nuage VSP solution is NOT supported in Basic zone provisioning mode. - -1. When adding a zone, the CloudStack administrator should select **Advanced** mode in the zone wizard. -2. When laying out the physical network configuration during zone provisioning, the **Guest** network traffic should be put in a separate physical network of its own. -3. This physical network carrying the **Guest** traffic should have **VSP** as the **Isolation Method**. - -.. figure:: /_static/images/nuage_vsp_isolation_method_setting.png - - Setting Isolation Method to VSP - -Update Traffic Labels -~~~~~~~~~~~~~~~~~~~~~ - -**Guest Traffic Type** - -Select **Edit** on the **Guest** traffic type panel and update the Traffic Label: - -- For KVM, use **alubr0** as the **KVM Traffic Label**. - -.. figure:: /_static/images/nuage_kvm_traffic_label.jpg - - Specifying the Traffic Type in KVM - -- For VMware ESXi, use the switch name used by **dVRS** for guest networking as the **vSwitch Name**, leave the **VLAN ID** field blank, and select **VMware vNetwork Distributed Switch** in the **vSwitch Type** drop down field. - -.. figure:: /_static/images/nuage_vmware_traffic_label.jpg - - Specifying the Traffic Type in VMware ESXi - -Enable Nuage VSP Network Service Provider -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Nuage VSP must be added and enabled as a Network Service Provider in the CloudStack Zone before it can be used. - -:Step 1: Select **Infrastructure > Zone > [zone name] > Physical Network 2 > Configure Network Service Providers > Nuage Vsp > +**, which brings up the **Add Nuage Virtualized Services Directory (VSD)** panel. - -:Step 2: Enter the Nuage VSD **Host Name**, **Username** and **Password** that was previously created. - -:Step 3: Specify the Nuage VSD API version by entering the API version in the appropriate field (format: ``v4_0``). - -:Step 4: *EITHER* Add **Nuage VSD** by clicking the **OK** button, - - *OR* use Nuage VSP API calls to configure Nuage VSP as a Network Service Provider in the CloudStack Zone; see `Configure Nuage VSP API`_ in the Appendix of this document. - -.. figure:: /_static/images/nuage_vsd_device_add.png - - Adding Nuage VSD as the Network Service Provider - -:Step 5: Go to **Infrastructure > Zones > [zone name] > Physical Network 2 > Network Service Providers > Nuage Vsp > Devices > Details** tab as shown in the figure "Enabling Nuage VSP Network Service Provider" below. This indicates the state of Nuage VSP Network Service Provider. Enable Nuage VSP Network Service Provider by clicking **Enable**. - -.. figure:: /_static/images/nuage_vsp_nsp_enable.png - - Enabling Nuage VSP Network Service Provider - -:Step 6: (Optional) View the Nuage VSP Network Service Provider status on the list of Network Service Providers on the **Infrastructure > Zones > [zone name] > Physical Network 2 > Network Service Providers** page; - -.. figure:: /_static/images/nuage_vsp_nsp_status.png - - Viewing Network Service Providers Status - - -Using The Nuage VSP Plugin --------------------------- - -Network Offerings -~~~~~~~~~~~~~~~~~ - -There are three types of Network Offerings that can be created: - -- If Isolated Networks are required, then create a **Isolated** guest type network offering for use with Isolated Networks. -- If VPC deployments are required, then create a new **Isolated** guest type network offering for such deployments. -- If Shared Networks are required, then create a new **Shared** guest type network offering for use with Shared Networks. - -.. note:: - **Per Zone** MUST always be selected as the **Supported Source NAT type** when **Source NAT** service is being provided by **NuageVsp**. - -Create and Enable Isolated Network Offering -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1. Select **Service Offerings > Select Offering: Network Offerings > Add network offering**, which brings up the **Add network offering**. - -2. In the **Add network offering** panel, add a **Name** and a **Description** to the network offering. Select **Isolated** as the **Guest Type**. In the **Supported Services** field select services and providers that are supported by the Nuage VSP Plugin for Isolated Networks, see `Supported Features`_ at the beginning of this document. - -.. figure:: /_static/images/nuage_iso_net_off.png - - Creating Isolated Network Offering - -3. Click the **OK** button to create the network offering. - -4. After the network offering has been successfully created, enable it from the **Service Offerings - Network Offerings** list. - -Create and Enable VPC Network Offering -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1. Select **Service Offerings > Select Offering: Network Offerings > Add network offering**, which brings up the **Add network offering**. - -2. In the **Add network offering** panel, add a **Name** and a **Description** to the network offering. Select **Isolated** as the **Guest Type**. Select the **VPC** field. In the **Supported Services** field select services and providers that are supported by the Nuage VSP Plugin for VPCs, see `Supported Features`_ at the beginning of this document. - -.. figure:: /_static/images/nuage_vpc_net_off.png - - Creating VPC Network Offering - -3. Click the **OK** button to create the network offering. - -4. After the network offering has been successfully created, enable it from the **Service Offerings - Network Offerings** list. - -Create and Enable Shared Network Offering -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1. Select **Service Offerings > Select Offering: Network Offerings > Add network offering**, which brings up the **Add network offering**. - -2. In the **Add network offering** panel, add a **Name** and a **Description** to the network offering. Select **Shared** as the **Guest Type**. In the **Supported Services** field select services and providers that are supported by the Nuage VSP Plugin for Shared Networks, see `Supported Features`_ at the beginning of this document. - -.. figure:: /_static/images/nuage_sha_net_off.png - - Creating Shared Network Offering - -.. note:: - Selecting the **Supporting Public Access** field in the Shared Network offering enables Public/Internet access to the VMs in the Shared Network. - -3. Click the **OK** button to create the network offering. - -4. After the network offering has been successfully created, enable it from the **Service Offerings - Network Offerings** list. - -VPC Offerings -~~~~~~~~~~~~~ - -Pre-created and Enabled Nuage VSP VPC Offering -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -A VPC offering by the name **Nuage VSP VPC Offering** is pre-created and enabled in the list of **Service Offerings - VPC Offerings** (Select **Service Offerings > Select Offering: VPC Offerings**) which contains all the services and providers that are supported by the Nuage VSP Plugin for VPCs. - -.. figure:: /_static/images/nuage_vsp_vpc_off.png - - Pre-created and Enabled Nuage VSP VPC Offering - -(Optional) Create and Enable VPC Offering -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1. Select **Service Offerings > Select Offering: VPC Offerings > Add VPC Offering**, which brings up the **Add VPC Offering**. - -2. In the **Add VPC Offering** panel, add a **Name** and a **Description** to the network offering. In the **Supported Services** field select services and providers that are supported by the Nuage VSP Plugin for VPCs, see `Supported Features`_ at the beginning of this document. - -.. figure:: /_static/images/nuage_vpc_off.png - - Creating VPC Offering - -3. Click the **OK** button to create the VPC Offering. - -4. After the VPC Offering has been successfully created, enable it from the **Service Offerings - VPC Offerings** list. - - -Dedicated Features Provided by The Nuage VSP Plugin ---------------------------------------------------- - -Nuage VSP Domain Template Feature Support for CloudStack -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -All the constructs (parameters and abstractions) defined in a Nuage VSD domain template can be made available to domain instances (i.e. networks) created in CloudStack. To do this, configure the Nuage VSP Plugin to use a pre-created Nuage VSD domain template when instantiating domains (i.e. creating networks). Networks created in CloudStack will then use domain instances created from the domain template. - -Typical use-cases are: - -* The basic ACLs on the top and bottom that bracket or 'contain' the end-user's ACLs. -* Leakable domains/GRT Leaking (Nuage VSP feature). - -To configure a Nuage VSP domain template for use by CloudStack, use the Nuage VSD Architect (VSP's GUI) to create a domain template and configure it in the following CloudStack global settings. - -.. cssclass:: table-striped table-bordered table-hover - -+-------------------------------------------+---------+------------------------------------------------------------------------------------------+---------------------------------+ -| Parameter | Type | Explanation | Supported CloudStack versions | -+===========================================+=========+==========================================================================================+=================================+ -| nuagevsp.isolatedntwk.domaintemplate.name | String | Name of the Nuage VSP domain template to use for creating domains for isolated networks | >= 4.5 | -+-------------------------------------------+---------+------------------------------------------------------------------------------------------+---------------------------------+ -| nuagevsp.vpc.domaintemplate.name | String | Name of the Nuage VSP domain template to use for creating the domain for VPCs | >= 4.5 | -+-------------------------------------------+---------+------------------------------------------------------------------------------------------+---------------------------------+ -| nuagevsp.sharedntwk.domaintemplate.id | UUID | UUID of the Nuage VSP domain template to use for creating the domain for Shared Networks | >= 4.10 | -+-------------------------------------------+---------+------------------------------------------------------------------------------------------+---------------------------------+ - -Table: CloudStack Global Settings For Configuring Nuage VSP Domain Template Feature - -Nuage VSP Source NAT via the Underlay Feature Support For CloudStack -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Supported CloudStack versions: >= 4.10 - -CloudStack provides Source NAT service to enable guest VMs to send traffic out to the Internet without requiring a Static NAT IP (public IP) assigned to the VM. The Source NAT service must be enabled as part of the network offering used for creating the guest network. When a network is created using this network offering, the first public IP from the assigned public IP range is automatically acquired as the Source NAT IP for the network. All VMs attached to this network then use that Source NAT IP to send traffic to the Internet. - -The Nuage VSP Plugin for CloudStack supports CloudStack's native Source NAT service and enhances it by restricting to a minimum the number of public IP addresses assigned to any given tenant. This is achieved by not allocating a Source NAT IP for every network that is created. - -The Source NAT service that Nuage VSP calls the Port Address Translation (PAT) feature uses the hypervisor IP as the Source NAT IP address for all VMs in the hypervisor that need to send traffic out to the Internet. Configure this during Nuage VSP installation using the instructions given in the Nuage VSP Install Guide. - -This feature is supported for both VPCs and Isolated Networks. In the case of VPCs, Source NAT is applied at the Nuage VSP domain level, therefore there is no customization on the individual VPC network (tier) level. - -All VPCs and Isolated networks that are created from a Nuage VSP Source NAT-enabled network offering have this feature enabled automatically. An example Nuage VSP Source NAT-enabled network offering is shown in the figure "Nuage VSP Source NAT-enabled Network Offering" below. - -.. figure:: /_static/images/nuage_source_nat_net_off.png - - Nuage VSP Source NAT-enabled Network Offering - -Nuage VSP Static NAT via the Underlay Feature Support For CloudStack -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Supported CloudStack versions: >= 4.10 - -Static NAT is supported in Nuage VSP as FIP (Floating IP). Prior to Nuage VSP v3.2, FIP in Nuage VSP required a VXLAN GW/PE to be present in the data center. In Nuage VSP v3.2 and above FIP is supported via the underlay, which removes the requirement for a GW/PE in the DC. - -For the Static NAT without GW/PE feature to be operational in the CloudStack plugin, FIP in Nuage VSP must be configured to use the underlay. This operation takes place during Nuage VSP installation; instructions can be found in the Nuage VSP Install Guide. - -A new API called ``nuageunderlayvlaniprange`` has been introduced to enable/disable Static NAT via the Underlay feature support for CloudStack public IP ranges being used for Static NAT service. This API specifies whether the FIP to underlay support is required for the corresponding FIP subnet in Nuage VSD since there is no GW/PE in the data center. When the ``nuageunderlayvlaniprange`` API has been enabled/disabled for a public IP range and Static NAT is enabled on at-least one of its Public IPs, the plugin creates the corresponding shared FIP subnet in Nuage VSD using the ``sharednetworkresources`` API with the underlay flag set accordingly. The ``nuageunderlayvlaniprange`` API usage is shown in the figure "nuageunderlayvlaniprange API Usage" below. - -.. figure:: /_static/images/nuage_underlay_api_usage.png - - nuageunderlayvlaniprange API Usage - -By default, the Nuage VSP Plugin creates the corresponding shared FIP subnet in Nuage VSD with the underlay flag set to false (disabled). There is no support for the ``nuageunderlayvlaniprange`` API from the CloudStack UI. - -.. note:: - Enabling/disabling the ``nuageunderlayvlaniprange`` API for CloudStack public IP ranges is supported only before the Nuage VSP plugin creates the corresponding shared FIP subnet in Nuage VSD. After a shared FIP subnet is created in Nuage VSD, its underlay flag cannot be changed. To change the underlay flag for a given shared FIP subnet, delete the Public vLanIPRange, recreate it and enable/disable the ``nuageunderlayvlaniprange`` API for it. - - -Running The Nuage VSP Plugin Specific Marvin Tests --------------------------------------------------- - -The Nuage VSP Plugin specific Marvin tests can be found under the directory test/integration/plugins/nuagevsp/ in the cloudstack tree. - -Here is the list of required Python packages and dependencies to run The Nuage VSP Plugin specific Marvin tests: - -- marvin -- vspk -- libVSD -- pyyaml -- netaddr -- futures - -.. note:: - vspk is a Python SDK for Nuage VSP's VSD and libVSD is a library that wraps vspk package, which are open sourced and can be found at https://github.com/nuagenetworks. - -Here is an example nosetests command to run The Nuage VSP Plugin specific Marvin tests: - -:: - - nosetests --with-marvin --marvin-config=path-to-marvin-config-file/nuage_marvin.cfg path-to-marvin-tests/test/integration/plugins/nuagevsp/test_nuage_vsp.py - -.. note:: - For an example Marvin config file (i.e. nuage_marvin.cfg) required to run The Nuage VSP Plugin specific Marvin tests, refer `Nuage VSP Marvin Config File Format`_ in the Appendix of this document. - - -Appendix --------- - -Configure Nuage VSP API -~~~~~~~~~~~~~~~~~~~~~~~ - -To configure Nuage VSP as a Network Service Provider in the CloudStack Zone. - -1. Add Nuage VSP as a Network Service Provider in the Physical Network 2: - -:: - - cloudmonkey add networkserviceprovider name=NuageVsp physicalnetworkid= - -2. Add the Nuage VSD as a Nuage VSP Device in the Physical Network 2: - -:: - - cloudmonkey add nuagevspdevice physicalnetworkid= hostname= username= password= port= apiversion= retrycount= retryinterval= - - -Nuage VSP Marvin Config File Format -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Format for the Marvin config file required to run The Nuage VSP Plugin specific Marvin tests. - -:: - - { - "zones": [ - { - "name": "ZONE1NAME", - "physical_networks": [ - { - "name": "Physical Network 1", - "isolationmethods": [ - "VLAN" - ] - }, - { - "name": "Physical Network 2", - "isolationmethods": [ - "VSP" - ], - "providers": [ - { - "name": "NuageVsp", - "devices": [ - { - "username": "VSDUSERNAME", - "retryinterval": "60", - "hostname": "VSDSERVER", - "apiversion": "VSDVERSION", - "retrycount": "4", - "password": "VSDUSERPASSWORD", - "port": VSDPORT - } - ] - } - ] - } - ], - "dcInternetConnectivityInfo" : { - "available": "INTERNETAVAILABLE", - "httpProxy": "HTTPPROXY", - "httpsProxy": "HTTPSPROXY" - } - }, - { - "name": "ZONE2NAME", - "physical_networks": [ - { - "name": "Physical Network 1", - "isolationmethods": [ - "VLAN" - ] - }, - { - "name": "Physical Network 2", - "isolationmethods": [ - "VSP" - ], - "providers": [ - { - "name": "NuageVsp", - "devices": [ - { - "username": "VSDUSERNAME", - "retryinterval": "60", - "hostname": "VSDSERVER", - "apiversion": "VSDVERSION", - "retrycount": "4", - "password": "VSDUSERPASSWORD", - "port": VSDPORT - } - ] - } - ] - } - ], - "dcInternetConnectivityInfo" : { - "available": "INTERNETAVAILABLE", - "httpProxy": "HTTPPROXY", - "httpsProxy": "HTTPSPROXY" - } - } - ], - "dbSvr": { - "dbSvr": "DBSERVER", - "passwd": "DBPASSWORD", - "db": "cloud", - "port": 3306, - "user": "DBUSERNAME" - }, - "logger": - { - "LogFolderPath": "/tmp/LOGFOLDERNAME" - }, - "mgtSvr": [ - { - "mgtSvrIp": "MGNTSERVERIP", - "port": 8096, - "user": "MGNTUSERNAME", - "passwd": "MGNTPASSWORD" - } - ] - } -