You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

What's this?

Details on the documentation needs for ACS 4.1. Note this plan was written during transition into Apache infrastructure, so it may still contain outdated links to, for example, Functional Specs on an older wiki.

Purpose

  • Update documentation for new features.
  • Update documentation for UI changes.
  • Respond to change request and bug tickets.

Assumptions and Risks

The time available before the release is short.

Documentation Deliverables and Outlines

Update for new features. The following table lists the new features and how they affect documentation.

We are committed to provide documentation for features marked P1 and P2.

Documentation plan is derived from the Apache CloudStack 4.1 QA Plan.

Update Docs for New Features

 

Feature

Engineering Contacts

Engineering Functional Spec

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

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Load+Balancer+Health+checks\\

JT

 

3

Netscaler LB on Shared VLANs

Rajesh Battala

https://cwiki.apache.org/confluence/display/CLOUDSTACK/LB+on+Shared+VLANs\\ https://cwiki.apache.org/confluence/display/CLOUDSTACK/L4-L7+network+services+in+shared+network\\

Radhika

 

4

F5 & SRX inline mode

Sheng

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Network+inline+mode+functional+spec\\


Radhika

 

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

 https://issues.apache.org/jira/browse/CLOUDSTACK-509\\


 

 

10

User provided hostname to be specified in vCenter 
instead of Cloud Platform generated name
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

 

 

15

High Availability: implement GSLB (Global Server Load Balancing) capability for ELB service

Murali

https://issues.apache.org/jira/browse/CLOUDSTACK-653\\ 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

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

6

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

 

7

Support non-contiguous VLAN ranges

Bharat

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Support+non-contiguous+VLAN+ranges|../../../../../../../../../display/CLOUDSTACK/Support+non-contiguous+VLAN+ranges\

Radhika

 

8

Security Groups Isolation in Advanced Zone

Anthony

 

JT

 

9

Site-to-Site VPN 2.0

 

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Site-to-Site+VPN+2.0|../../../../../../../../../display/CLOUDSTACK/Site-to-Site+VPN+2.0\

Radhika

 

10

Dedicated Resources

Likitha+ Deepti + Saksham+Devdeep

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Dedicated+Resources+Public+IP+Addresses+and+VLANs+per+Tenant|../../../../../../../../../display/CLOUDSTACK/Dedicated+Resources+Public+IP+Addresses+and+VLANs+per+Tenant\
https://cwiki.apache.org/confluence/display/CLOUDSTACK/IP+Range+Reservation+within+a+Network|../../../../../../../../../display/CLOUDSTACK/IP+Range+Reservation+within+a+Network\
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Persistent+Networks|../../../../../../../../../display/CLOUDSTACK/Persistent+Networks\
Feature: Limit resources to domain/account
http://mindtouch.citrite.net/Releases/Merlin/Features/CloudStack_and_AWS_Support/CloudStack_Feature_Requests
Feature: Private host, cluster, pod

 

 

11

IPv6 Support

Sheng

 

Radhika

 

12

Storage XenMotion/Migration

Devdeep

https://issues.apache.org/jira/browse/CLOUDSTACK-659\\ https://cwiki.apache.org/confluence/display/CLOUDSTACK/Enabling+Storage+XenMotion+for+XenServer

 

 

13

VMWare Enhancements: Support for DRS, VM HA

Sateesh

Feature: VMWare Enhancements: Support for DRS, VM HA

Radhika

 

14

Support VMware DVSwitch

Sateesh

Feature: VMWare Enhancements: Support VMware DVSwitch

Radhika

 

15

VM Reset (Reset-on-boot)

Hari P

Feature: Specify VM shutdown behavior (destroy, restart with a new boot drive)
http://mindtouch.citrite.net/Releases/Merlin/Features/CloudStack_and_AWS_Support/CloudStack_Feature_Requests

JT

 

16

Persistent Network Identity

Hari P

http://mindtouch.citrite.net/Releases/Merlin/Features/CloudStack_and_AWS_Support/CloudStack_Feature_Requests

JT

 

17

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

 

18

CPU/Memory OverCommit

Bharat (XS)
Koushik (VMWare)
Rohit (KVM)

Feature: CPU/Memory OverCommit

JT

 

19

Monitoring

Anshul

Feature: SNMP Alerts
Feature: Syslogs

JT

 

20

Limit API Queries (CLOUDSTACK-618)

Min Chen

Feature: Limit API Queries

JT

 

21

Improve API Performance / Add Search Capabilities
(CLOUDSTACK-527)

Min Chen

https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+API+refactoring|../../../../../../../../../display/CLOUDSTACK/CloudStack+API+refactoring\

JT

 

22

Object Store-Integration with CS as secondary Storage

Nitin

https://cwiki.apache.org/confluence/display/CLOUDSTACK/S3-based+secondary+Storage\\

Radhika

 

23

EBS Shared NFS Zone-wide (primary) Block Storage

Anthony

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Shared+NFS+Zone-wide+(primary)Block+Storage|../../../../../../../../../display/CLOUDSTACK/Shared+NFS+Zone-wide(primary)+Block+Storage\

JT

 

24

Raise cluster size limit to 16

Koushik

Feature: Raise cluster size limit to 16

JT

 

25

Dynamic Resource Scaling

Nitin Mehta

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Dynamic+scaling|../../../../../../../../../display/CLOUDSTACK/Dynamic+scaling\

JT

 

26

Events framework to publish/subscribe to CloudStack events

Murali

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Event+Notification+Framework+Proposal|../../../../../../../../../display/CLOUDSTACK/Event+Notification+Framework+Proposal\ 
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Event+Notification+with+message+oriented+middleware+Proposal|../../../../../../../../../display/CLOUDSTACK/Event+Notification+with+message+oriented+middleware+Proposal\

JT

 

27

Integrate Cisco VSG in CloudStack

Koushik Das

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Integrate+Cisco+Virtual+Security+Gateway+%28VSG%29+into+CloudStack|../../../../../../../../../display/CLOUDSTACK/Integrate+Cisco+Virtual+Security+Gateway+%28VSG%29+into+CloudStack\ 

 

 

28

Integrate Cisco ASA 1000v into CloudStack

Koushik Das

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Integrate+Cisco+ASA+1000v+as+a+FW+for+CloudStack|../../../../../../../../../display/CLOUDSTACK/Integrate+Cisco+ASA+1000v+as+a+FW+for+CloudStack\ 

 

 

29

Zone-wide primary storage target

Anthony

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Zone-wide+primary+storage+target|../../../../../../../../../display/CLOUDSTACK/Zone-wide+primary+storage+target\

JT

 

30

IP Address reservation within a network

Saksham

https://cwiki.apache.org/confluence/display/CLOUDSTACK/IP+Range+Reservation+within+a+Network|../../../../../../../../../display/CLOUDSTACK/IP+Range+Reservation+within+a+Network\ 

Radhika

 

31

Volume snapshot enhancements for VMware

Kelven Yang

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Volume+snapshot+enhancements+for+VMware|../../../../../../../../../display/CLOUDSTACK/Volume+snapshot+enhancements+for+VMware\

JT

 

32

Configurable setting to use linked clones or not on VMware

Vijay

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Configurable+setting+to+use+linked+clones+or+not+on+VMware|../../../../../../../../../display/CLOUDSTACK/Configurable+setting+to+use+linked+clones+or+not+on+VMware\ 

JT

 

33

VM's base image update facility

Hari P

https://cwiki.apache.org/confluence/display/CLOUDSTACK/Base+Image+Updation+facility|../../../../../../../../../display/CLOUDSTACK/Base+Image+Updation+facility\

JT

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

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 timeframe.

  • Set up documentation repos related to Apache project incubation for non-committers
  • Set up tools to build and publish documentation sets on a new doc website
  • Community outreach activities: presentations at professional gatherings, presence on mailing lists, etc.
  • No labels