...

Details on the documentation needs for ACS Apache CloudStack 4.1.

Table of Contents

maxLevel	3

...

The time available before the release is short. The list of features to be included in the release is in flux, making it difficult to plan which features to write about first.

Documentation Deliverables and Outlines

The Documentation plan is derived from the 4.1 Release Page and the Apache CloudStack 4.1 QA Plan. The following table lists the new features and how they affect documentation. We are committed to provide documentation for features marked P1 and P2.

Update Docs for New Features

	Feature	Impact on the Documentation	Engineering Contacts	Links: Engineering Functional Spec + Doc Bug Number	Writer	Status
1	AWS-Style Regions	Kishan Kavala	https://cwiki.apache.org/confluence/display/CLOUDSTACK/AWS-Style+Regions	JT		2	AWS-style Health Checks	Rajesh Battala	JT		3	Netscaler LB on Shared VLANs	Rajesh Battala	aws-ec2-introduction.xml: add paragraph that gives an overview of the feature. New section about-regions.xml. Include in concepts.xml. Various how-to sections like viewing-regions.xml, defining-regions.xml, deleting-regions.xml. release-notes.xml: What's New Global config settings: revise one-line descriptions that appear on Settings screen in UI to show whether the setting affects a region or just a zone management-server-install-multi-node.xml: Note that all management servers for a region have to be in a single zone within the region. about-secondary-storage.xml: A note about how storage is available from a single data store across an entire region. Is this the existing secondary storage, or is a new level of storage being introduced? Throughout docs: It's possible the UI path to all resources might now start with "Click the region" rather than "Click the zone." This_Link_To_The_Spec_Is_Intended_To_Widen_This_Table_Column	Kishan Kavala	Doc: CLOUDSTACK-815 Eng: CLOUDSTACK-241 AWS-Style+Regions	JT	API is documentation in the Dev Guide (radhika)
2	Radhika		4	F5 & SRX inline mode		Sheng	https://cwiki.apache.org/confluence/display/CLOUDSTACK/Network Doc: CLOUDSTACK-800 Eng: CLOUDSTACK-306 Network+inline+mode+functional+spec	Radhika	done
3
5	Optional Public IP assignment for EIP with Basic Zone	Murali	https://cwiki.apache.org/confluence/display/CLOUDSTACK/L4-L7+network+services+in+shared+network https://cwiki.apache.org/confluence/display/CLOUDSTACK/Optional+Public+IP+assignment+for+EIP+with+Basic+Zone https://issues.apache.org/jira/browse/CLOUDSTACK-265	Radhika
6	AutoScale	Vijay	https://cwiki.apache.org/confluence/display/CLOUDSTACK/Autoscaling https://issues.apache.org/jira/browse/CLOUDSTACK-637
7	Advanced Search UI	Brian
8	L4-L7 network services in shared network	Murali	https://cwiki.apache.org/confluence/display/CLOUDSTACK/L4-L7+network+services+in+shared+network https://issues.apache.org/jira/browse/CLOUDSTACK-312
9	S3-backed Secondary Storage	John Burwell
10	User provided hostname to be specified in vCenter instead of Cloud Platform generated name	Vijay B	https://cwiki.apache.org/confluence/display/CLOUDSTACK/Allow+user+provided+hostname%2C+internal+VM+name+on+hypervisor+for+guest+VMs https://issues.apache.org/jira/browse/CLOUDSTACK-778
11	EC2 Query API support	Likitha	https://cwiki.apache.org/confluence/display/CLOUDSTACK/EC2++-+Functional+Spec+for+Query+API+support https://issues.apache.org/jira/browse/CLOUDSTACK-197
12	API Request Throttling	Min	https://cwiki.apache.org/confluence/display/CLOUDSTACK/API+Request+Throttling https://issues.apache.org/jira/browse/CLOUDSTACK-618
13	Storage subsystem 2.0	Edison	https://issues.apache.org/jira/browse/CLOUDSTACK-629 https://cwiki.apache.org/confluence/display/CLOUDSTACK/Storage+subsystem+2.0
14	High Availability: EIP enhancements	Murali	https://issues.apache.org/jira/browse/CLOUDSTACK-652
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9989b897-3ac8-437b-8679-d3e643413d35"><ac:plain-text-body><![CDATA[	15	High Availability: implement GSLB (Global Server Load Balancing) capability for ELB service	Murali	[https://issues.apache.org/jira/browse/CLOUDSTACK-653]	[https://issues.apache.org/jira/browse/CLOUDSTACK-653 ]]></ac:plain-text-body></ac:structured-macro> ]] https://cwiki.apache.org/confluence/display/CLOUDSTACK/GSLB+%28Global+Server+Load+Balancing%29+Functional+specification+and+Design+DocumentX
16	VM's base image update facility (includes Reset a VM on reboot)	Harikrishna Patnala	https://cwiki.apache.org/confluence/display/CLOUDSTACK/Base+Image+Updation+facility
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4a5f0441-8204-43a1-9d6c-a3bb2f4bba6f"><ac:plain-text-body><![CDATA[	17	Enhanced baremetal servers support on Cisco UCS	Frank zhang			18	Events framework to publish/subscribe to CloudStack events	Murali			19	New Image based provisioning method for Baremetal	Frank zhang			20	OVS support in KVM	Hugo	Hugo	21	XenServer updates notifications	Sanjay T	JT
22	Reset SSH Key to access VM (similar to reset password)	Harikrishna Patnala	https://issues.apache.org/jira/browse/CLOUDSTACK-297	JT
23	nTier Apps 2.0 Requirements	Sheng + Kishan Kavala	https://issues.apache.org/jira/browse/CLOUDSTACK-621 https://cwiki.apache.org/confluence/display/CLOUDSTACK/nTier+Apps+2.0+Requirements	Radhika
24	Support non-contiguous VLAN ranges	Bharat	https://issues.apache.org/jira/browse/CLOUDSTACK-701	Radhika
25	Security Groups Isolation in Advanced Zone	Anthony	https://issues.apache.org/jira/browse/CLOUDSTACK-737	JT
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1628127e-a9f4-4efc-ac01-7a7e4bdfc23b"><ac:plain-text-body><![CDATA[	26	Site-to-Site VPN 2.0	Sheng	[https://issues.apache.org/jira/browse/CLOUDSTACK-703 ]]></ac:plain-text-body></ac:structured-macro> ]	Radhika
27	Dedicated Resources: Dedicate Pod, Cluster or Host to a domain	Deepti			28	Dedicated Resources: Persistent Networks without running a VM	Likitha			29	Dedicated Resources - Public IP Addresses and VLANs per Tenant	Likitha			30	Dedicated Resources:Limit Resources to domain/accounts	Sanjay Tripathi
31	Egress firewall rules for guest network	Jaypal Reddy	https://issues.apache.org/jira/browse/CLOUDSTACK-299	Radhika
32	Specify egress rules on VR	Jaypal Reddy
33	Health monitoring for load balanced instances	Rajesh	https://issues.apache.org/jira/browse/CLOUDSTACK-443
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="77a02b62-e7f5-4a7c-996e-dc90e4068085"><ac:plain-text-body><![CDATA[	34	3rd Party Plugin	Sonny
35	IPv6 Support	Sheng	?	Radhika
36	Storage XenMotion/Migration	Devdeep	https://issues.apache.org/jira/browse/CLOUDSTACK-659 https://cwiki.apache.org/confluence/display/CLOUDSTACK/Enabling+Storage+XenMotion+for+XenServer
37	VMWare Enhancements: Support for DRS, VM HA	Sateesh	?
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="39685c51-f351-4309-929a-f9cce7c91f4e"><ac:plain-text-body><![CDATA[	38	VMware vNetwork Distributed Virtual Switch support in CloudStack	Sateesh	Radhika		39	Additional VMX Settings	Vijay B			<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6d0ec27d-c03c-4a3d-83d6-a8e0a428d968"><ac:plain-text-body><![CDATA[	40	Resize volumes feature	Marcus Sorensen	JT		41	Add/remove network on VM	Marcus Sorensen		42	ELB: auto-scale request handling capacity by provisioning LB appliances	Murali Reddy		43	Framework for CloudStack to orchestrate virtual network appliances to provide network services	Murali Reddy		44	Support VM Snapshot	Mice Xia
45	Persistent Network Identity	Hari P	http://mindtouch.citrite.net/Releases/Merlin/Features/CloudStack_and_AWS_Support/CloudStack_Feature_Requests	JT
46	Multiple IP Address per NIC	Jaypal	https://issues.apache.org/jira/browse/CLOUDSTACK-24 https://cwiki.apache.org/confluence/display/CLOUDSTACK/Multiple+IP+address+per+NIC	Radhika
47	CPU/Memory OverCommit	Bharat (XS) Koushik (VMWare) Rohit (KVM)	JT
48	Monitoring	Anshul	https://issues.apache.org/jira/browse/CLOUDSTACK-680 https://cwiki.apache.org/confluence/display/CLOUDSTACK/FS+for+Integrating+CS+alerts+via+SNMP+to+external+management+system	JT
49	syslog enhancements	Anshul
	Limit API Queries (CLOUDSTACK-618)	Min Chen	?	JT
	Improve API Performance / Add Search Capabilities (CLOUDSTACK-527)	Min Chen	?	JT
50	Object Store-Integration with CS as secondary Storage	Nitin	Radhika		<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7d742a36-f5c1-4b17-b6f4-34d34a8ce036"><ac:plain-text-body><![CDATA[	51	Zone-wide (primary) Block Storage	Edison	JT
52	Raise cluster size limit to 16	Koushik	https://issues.apache.org/jira/browse/CLOUDSTACK-672	JT
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1cc77f84-79c6-4bfa-a3ba-4bf49fef0417"><ac:plain-text-body><![CDATA[	53	Dynamic Resource Scaling (Scaling up CPU and RAM for running VMs)	Nitin Mehta	JT		54	Allow for same vlan on different physical nics	Kishan Kavala	JT		55	Multiple IP Ranges	Bharat			56	Integrate Cisco VSG in CloudStack	Koushik Das		57	Integrate Cisco ASA 1000v into CloudStack	Koushik Das		58	Zone-wide primary storage target	Anthony	JT	59	IP Address reservation within a network	Saksham	Radhika	<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c3d2cc08-a983-44ed-88cb-1fb7999e7abd"><ac:plain-text-body><![CDATA[	60	Volume snapshot enhancements for VMware + Better VM Sync	Kelven Yang	JT	<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="11afb21a-2b4d-4150-ad54-fef07626cbc2"><ac:plain-text-body><![CDATA[	61	Configurable setting to use linked clones or not on VMware	Vijay B	JT	62	BigSwitch network plugin	Kanzhe Jiang	JT	<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="dd2d967c-7ecf-4259-bdf0-614f72d81943"><ac:plain-text-body><![CDATA[	63	Affinity / Anti-affinity Rules	Prachy
64	Granular Global Parameters	Hari P	https://issues.apache.org/jira/browse/CLOUDSTACK-741
65	Support multiple subnets per vlan for KVM HV	Anthony Xu	https://issues.apache.org/jira/browse/CLOUDSTACK-788

Installation Guides: Update

Each new releases requires an update of the existing Installation Guide. A major rewrite is required for "build from source" installation procedure.

Release Notes

API Reference: Update

Each new release requires an update of the existing API Reference man pages. These are auto-generated and require only posting to the website.

Documentation Bugs

It is assumed that bugs will be filed against documentation and some will be prioritized for this release. Currently known doc bugs per release can be obtained by querying the bugbase. Triage of existing bugs is needed to determine which are required in this release. The goal is to address as many as possible of the bugs that reflect inaccuracies in the documentation. Enhancement requests can be targeted to a later release.

Translation

Publican can output .po files which we can use to translate documentation into any desired language. DECISIONS REQUIRED:

Which languages to translate?
Use Transifex
Use community volunteers? We already have one volunteer for Chinese translation.

Additional Doc Activities

In addition to the deliverables noted,additional activities are required during this time frame.

...

AutoScale		Vijay	Doc: CLOUDSTACK-813 Eng: CLOUDSTACK-637 Autoscaling	Radhika	done
4	Advanced Search UI	Not sure this really needs documentation.	Brian	Doc: CLOUDSTACK-827 Eng: CLOUDSTACK-662		Parent eng bug marked Reopened 2/27
5	S3-backed Secondary Storage		John Burwell	Doc: CLOUDSTACK-878 Eng: CLOUDSTACK-509		Parent eng bug Reopened 2/27
6	EC2 Query API support		Likitha	Doc: CLOUDSTACK-829 Eng: CLOUDSTACK-197 Query+API+support	Sebastien	On Track. (When was this status written? Need to check in w/Sebastien) Parent eng bug is still open 2/27
7	API Request Throttling		Min	Doc: CLOUDSTACK-866 Eng: CLOUDSTACK-618 API+Request+Throttling	JT	Feature is ready to document. Not started.
8	Enhanced baremetal servers support on Cisco UCS		Frank zhang	Doc: CLOUDSTACK-861 Eng: CLOUDSTACK-723 Enhanced+Baremetal+support+on+Cisco+UCS Cisco+UCS+Integration+functional+spec	Radhika	Parent eng bug marked In Progress 2/27 Cisco+UCS+Integration+functional+spec
9	Events framework to publish/subscribe to CloudStack events		Murali	Doc: CLOUDSTACK-1270 Eng: CLOUDSTACK-820	Radhika	Done. Parent eng bug marked Unresolved 2/27
10	OVS support in KVM		Hugo	Doc: CLOUDSTACK-824 Eng: CLOUDSTACK-101	Hugo	Done
11	Reset SSH Key to access VM (similar to reset password)		Harikrishna Patnala	Doc: CLOUDSTACK-830 Eng: CLOUDSTACK-297	JT	done. Worth double-checking that the doc is in 4.1, not just master.
12	Security Groups Isolation in Advanced Zone		Anthony	Doc: CLOUDSTACK-805 Eng: CLOUDSTACK-737	JT	done. *ALERT* It appears the feature code was reverted, but the docs were not. Need to check into this!
13	Site-to-Site VPN: Monitoring of VPN Tunnels		Sheng	Doc: CLOUDSTACK-806 Eng: CLOUDSTACK-703 Monitoring of VPN Tunnels site-to-site-vpn.html	Radhika	done. *ALERT* The parent eng bug has been moved to 4.2. Need to check whether the docs were reverted. (Radhika: The sub task monitoring vpn tunnel is part of 4.1. Confirmed)(JT: Thanks Radhika. Then this is really "Done.")
14	Persistent Networks without running a VM		Likitha	Doc: CLOUDSTACK-852 Eng: CLOUDSTACK-706	Radhika	done
15	Egress firewall rules for guest network		Jaypal Reddy	Doc: CLOUDSTACK-1028 Eng: CLOUDSTACK-299	Radhika	Done. Parent eng bug still Open 2/27 (question of whether the code was checked in to 4.1)
16	Additional VMX Settings		Vijay B	Doc: CLOUDSTACK-811 Eng: CLOUDSTACK-780	Radhika	done
17	Resize volumes feature		Marcus Sorensen	Doc: CLOUDSTACK-887 Eng: CLOUDSTACK-644 Resize+Data+Volumes	Radhika	done /r/9520
18	Add/remove network on VM		Marcus Sorensen	Doc: CLOUDSTACK-890 Eng: CLOUDSTACK-645 Add+Remove+Networks+to+VM	Radhika	Done [https://reviews.apache.org/r/9726/ ]
19	Limit API Queries		Min Chen	Doc: CLOUDSTACK-866 Eng: CLOUDSTACK-618	JT	Parent eng bug marked Fixed in 4.1 2/27
20	Improve API Performance / Add Search Capabilities		Min Chen	Doc: CLOUDSTACK-865 Eng: CLOUDSTACK-527	JT	Parent eng bug marked Fixed in 4.1. This is not listed in the 4.1 Features List-- why not? Docs not started. 2/27
21	Allow for same vlan on different physical nics		Marcus	Doc: CLOUDSTACK-1221 Eng: CLOUDSTACK-686	Radhika	Done. Parent eng bug marked fixed for 4.1. (This is from the Improvements list on the 4.1 Release wiki page.)
22	BigSwitch network plugin		Kanzhe Jiang	Doc: CLOUDSTACK-1442 Eng: CLOUDSTACK-733	JT	Parent eng bug marked In Progress 2/27
23	ApiDiscoverService: Implement a plugin mechanism that exposes the list of APIs through a discovery service on the management server		Rohit	Doc: CLOUDSTACK-1441 Eng: CLOUDSTACK-926		Parent eng bug marked Fixed in 4.1
24	Implement L3 Router functionality in Nicira Nvp Plugin		Hugo	Doc: CLOUDSTACK-862 Eng: CLOUDSTACK-726	Hugo	Parent eng bug marked Fixed in 4.1
25	Mash up marvin into an interactive auto-completing API shell for CloudStack (aka Cloudmonkey CLI)		Rohit	Doc: CLOUDSTACK-825 Eng: CLOUDSTACK-132	Sebastien	Parent eng bug marked Fixed in 4.1. Doc bug still In Progress. There are some cloudmonkey docs in the wiki. 2/27
26	Baremetal kickstart		Frank	Doc: CLOUDSTACK-1478 Eng: CLOUDSTACK-774	JT	Not started. (This is from the Improvements list on the 4.1 Release wiki page.)
27	Nicira NVP/KVM	Not sure whether this affects docs.	Hugo	Eng: CLOUDSTACK-727		?? (This is from the Improvements list on the 4.1 Release wiki page.)
28	Netscaler plugin	Not sure whether this is going in 4.1	Vijay V.	Eng: CLOUDSTACK-716		?? (This is from the Improvements list on the 4.1 Release wiki page.)
27	Update Developer Guide	Add new/changed APIs to "What's New" lists			Radhika	On Track
28	Release Notes 4.1				jzb
29	Update Installation Guides				jzb
30	Documentation Bugs			Open 4.1 Doc Bugs in Jira		Need to fix, close, or bump. There are 54 open bugs as of 2/28.
31	API changes for IPv6 Support				Radhika

Installation Guides: Update

Each new release requires an update of the existing Installation Guide. Looking for community contribution.

Release Notes

Each new release requires an update of existing Release Notes. New features, Known issues, and Fixed issues sections require major rewrite.

API Reference: Update

Each new release requires an update of the existing API Reference man pages. These are auto-generated and require only posting to the website.

Documentation Bugs

Open 4.1 Doc Bugs in Jira

It is assumed that bugs will be filed against documentation and some will be prioritized for this release. Currently known doc bugs per release can be obtained by querying the bugbase. Triage of existing bugs is needed to determine which are required in this release. The goal is to address as many as possible of the bugs that reflect inaccuracies in the documentation. Enhancement requests can be targeted to a later release.

Translation

Publican can output .po files which we can use to translate documentation into any desired language.

We are using Transifex to obtain community contributed translations of the documentation. For more information, see http://www.slideshare.net/sebastiengoasguen/how-to-translate-apache-cloudstack-docs.

Additional Doc Activities

In addition to the deliverables noted,additional activities are required during this time frame.

Community outreach activities: presentations at professional gatherings, presence on mailing lists and social media, organizing CloudStack meetups etc.

Timeline

Feb 4-11

Persistent Network

Status: Shared for review (Sailaja and Likitha)

Doc impact: Admin Guide, Developer Guide, and Release Notes

Feb 11-15

Persistent Network

Status: Patch submitted (Admin Guide, Dev Guide)

AWS-Style Regions

Status: Research state

Doc impact: Admin Guide, Developer Guide, and Release Notes

Event Notification Framework

Status: First draft of conceptual info ready

Developer Guide

Status: Patch is submitted ( initial set of API changes included)

Feb 18-22

Event Notification Framework: Tech review done. Incorporating comments. Awaiting info on configuration part.

CLOUDSTACK-1313: Patch submitted. Need to merge on Master and 4.0 (https://reviews.apache.org/r/9492/)

CLOUDSTACK-991: Patch merged (https://reviews.apache.org/r/9490/)

Resize Volume: Patch submitted. Ready to review (https://reviews.apache.org/r/9520/)

S2S VPN: Patch submitted. Need to merge (https://reviews.apache.org/r/9514/)

Feb 25 - March 1

Event Notification Framework: Merged.

Resubmitted the patch https://reviews.apache.org/r/8636/

Allow for same vlan on different physical nics: Swamy reviewed. Merged to master n 4.1

IP Reservation (4.2 feature): sent for tech review

March 4-8

IP Reservation (4.2 feature): Review comments incorporated (3/5)

Add/Remove Network on VM : https://reviews.apache.org/r/9726/

AWS Style Regions: Dev Guide has been updated

IPv6 API: First draft shared with QA for review

March 11-15

dvSwitch: Documented the UI specific tasks, overview

IPv6: Done review with QA. Addition points have been added.

March 18-21

IPv6: Send for second round of technical review

Fixed CLOUDSTACK-1409

...

Space shortcuts

Child pages

Versions Compared

Old Version 11

New Version Current

Key

Documentation Deliverables and Outlines

Update Docs for New Features

Installation Guides: Update

Release Notes

API Reference: Update

Documentation Bugs

Translation

Additional Doc Activities

Installation Guides: Update

Release Notes

API Reference: Update

Documentation Bugs

Translation

Additional Doc Activities

Timeline

Feb 4-11

Feb 11-15

Feb 18-22

Feb 25 - March 1

March 4-8

March 11-15

March 18-21

Space shortcuts

Child pages

Page History

Versions Compared

Old Version 11

New Version Current

Key

Documentation Deliverables and Outlines

Update Docs for New Features

Installation Guides: Update

Release Notes

API Reference: Update

Documentation Bugs

Translation

Additional Doc Activities

Installation Guides: Update

Release Notes

API Reference: Update

Documentation Bugs

Translation

Additional Doc Activities

Timeline

Feb 4-11

Feb 11-15

Feb 18-22

Feb 25 - March 1

March 4-8

March 11-15

March 18-21