[PROPOSAL] - Reference Guide for CloudStack configuration parameters
Hi, All, This is part of the effort to create a Reference Guide for CloudStack configuration parameters. This guide intends to provide a single point of reference for the configuration parameters that we use in CloudStack. Each parameter will be treated as a topic in this guide. I am planning to document the following information for each parameter: - Name and description of the parameter. - List of features that the users can configure using the parameter. - Changes in the behavior of each parameter when users provide low, optimal, and high values to the parameters. - Warnings, notes, and limitations for each parameter. - Example for each parameter - Explaining the parameter with the help of scenarios. - Impact of each configuration parameter on APIs. - Scope of the parameter - global, zone-level, or cluster-level. - Dependencies among the configuration parameters. - Category to which the parameter belongs. Will let you know more about this effort as we progress with this guide. Please find attached the list of CloudStack parameters that are categorized according to the functional areas they belong to. Could you please review this list and let me know your review comment/confirmation? Also, I have a few parameters listed under the heading *Others (To be categorized)*. Could you please help me categorize these parameters? Thanks, Rajsekhar cloudstack-config-param-categories.docx Description: MS-Word 2007 document
Re: [PROPOSAL] - Reference Guide for CloudStack configuration parameters
Hi, All, Thanks for your responses. I am sure we will be able to create a complete reference guide for the CloudStack parameters. I think I can create a wiki page that explains this effort and publish this list of categories there. I think it will be easier for you to review the list then. Will let you know after I create this wiki page. Thanks, Rajsekhar On Mon, Feb 15, 2016 at 5:07 PM, Daan Hoogland wrote: > I like the idea but shouldn't it be part of the source code and extracted > from there? What is the need to have it in a separate wiki? > > On Mon, Feb 15, 2016 at 9:18 AM, Rohit Yadav > wrote: > > > Nice, maybe put this on our cwiki so others can collaborate than do this > > over a word doc? > > > > Regards. > > > > > > [image: ShapeBlue] <http://www.shapeblue.com> > > Rohit Yadav > > Software Architect , ShapeBlue > > d: * | s: +44 203 603 0540* <%7C%20s:%20+44%20203%20603%200540> | m: > > *+91 8826230892* <+91%208826230892> > > e: *rohit.ya...@shapeblue.com | t: * > > | w: *www.shapeblue.com* > > <http://www.shapeblue.com> > > a: 53 Chandos Place, Covent Garden London WC2N 4HS UK > > Shape Blue Ltd is a company incorporated in England & Wales. ShapeBlue > > Services India LLP is a company incorporated in India and is operated > under > > license from Shape Blue Ltd. Shape Blue Brasil Consultoria Ltda is a > > company incorporated in Brasil and is operated under license from Shape > > Blue Ltd. ShapeBlue SA Pty Ltd is a company registered by The Republic of > > South Africa and is traded under license from Shape Blue Ltd. ShapeBlue > is > > a registered trademark. > > This email and any attachments to it may be confidential and are intended > > solely for the use of the individual to whom it is addressed. Any views > or > > opinions expressed are solely those of the author and do not necessarily > > represent those of Shape Blue Ltd or related companies. If you are not > the > > intended recipient of this email, you must neither take any action based > > upon its contents, nor copy or show it to anyone. Please contact the > sender > > if you believe you have received this email in error. > > > > > > On 14-Feb-2016, at 5:37 AM, Rajsekhar K > wrote: > > > > Hi, All, > > > > This is part of the effort to create a Reference Guide for CloudStack > > configuration parameters. This guide intends to provide a single point of > > reference for the configuration parameters that we use in CloudStack. > Each > > parameter will be treated as a topic in this guide. > > > > I am planning to document the following information for each parameter: > > > > > >- Name and description of the parameter. > >- List of features that the users can configure using the parameter. > >- Changes in the behavior of each parameter when users provide low, > >optimal, and high values to the parameters. > >- Warnings, notes, and limitations for each parameter. > >- Example for each parameter - Explaining the parameter with the help > >of scenarios. > >- Impact of each configuration parameter on APIs. > >- Scope of the parameter - global, zone-level, or cluster-level. > >- Dependencies among the configuration parameters. > >- Category to which the parameter belongs. > > > > > > Will let you know more about this effort as we progress with this guide. > > > > Please find attached the list of CloudStack parameters that are > > categorized according to the functional areas they belong to. Could you > > please review this list and let me know your review comment/confirmation? > > > > Also, I have a few parameters listed under the heading * Others (To be > > categorized)*. Could you please help me categorize these parameters? > > > > Thanks, > > Rajsekhar > > > > > > > > Regards. > > > > Find out more about ShapeBlue and our range of CloudStack related > services: > > IaaS Cloud Design & Build > > <http://shapeblue.com/iaas-cloud-design-and-build//> | CSForge – rapid > > IaaS deployment framework <http://shapeblue.com/csforge/> > > CloudStack Consulting <http://shapeblue.com/cloudstack-consultancy/> | > CloudStack > > Software Engineering > > <http://shapeblue.com/cloudstack-software-engineering/> > > CloudStack Infrastructure Support > > <http://shapeblue.com/cloudstack-infrastructure-support/> | CloudStack > > Bootcamp Training Courses <http://shapeblue.com/cloudstack-training/> > > > > > > -- > Daan >
How do I contribute to ACS documentation?
Hi, All, I am Rajsekhar Kunnampally, working with Citrix CloudPlatform documentation team. I am working from Citrix, Bangalore. I have been associated with the CloudPlatform documentation team for the past one year. My focus was on revamping the CloudPlatform documentation set and creating content for new releases, hotfixes, and patches. I would like to contribute to the ACS documentation too. I think I can start by creating documentation to complement the contributions from the CloudPlatform engineers. However, I would like to understand the tools and the processes that ACS documentation uses. Also, I have a few questions that I would like to clarify before I start contributing to ACS documentation. Who can I contact for guidance? Thanks in advance for your help. Regards, Rajsekhar
Re: How do I contribute to ACS documentation?
Hi, Daan, Sebastien, Thanks for your help. I have completed the initial setup. I hope I can start contributing to the ACS documentation. Thanks, Rajsekhar On Mon, Jun 8, 2015 at 3:46 PM, Sebastien Goasguen wrote: > Check the README at: > > https://github.com/apache/cloudstack-docs > https://github.com/apache/cloudstack-docs-rn > https://github.com/apache/cloudstack-docs-install > https://github.com/apache/cloudstack-docs-admin > > > On Jun 8, 2015, at 12:03 PM, Daan Hoogland > wrote: > > > > Rajsekhar, > > > > You can clone the docs project on github and create pull requests. > > There is no central human point of contact. Hope this suffices. > > > > On Fri, Jun 5, 2015 at 5:40 PM, Rajsekhar K > wrote: > >> Hi, All, > >> > >> I am Rajsekhar Kunnampally, working with Citrix CloudPlatform > documentation > >> team. I am working from Citrix, Bangalore. > >> > >> I have been associated with the CloudPlatform documentation team for the > >> past one year. My focus was on revamping the CloudPlatform documentation > >> set and creating content for new releases, hotfixes, and patches. > >> > >> I would like to contribute to the ACS documentation too. I think I can > >> start by creating documentation to complement the contributions from the > >> CloudPlatform engineers. However, I would like to understand the tools > and > >> the processes that ACS documentation uses. Also, I have a few questions > >> that I would like to clarify before I start contributing to ACS > >> documentation. > >> > >> Who can I contact for guidance? > >> > >> Thanks in advance for your help. > >> > >> Regards, > >> Rajsekhar > > > > > > > > -- > > Daan > >
[Proposal] Template for CloudStack API Reference Pages
Hi, All, This is the proposal for a new template for CloudStack API reference pages. This template is based on the reference page templates for REST APIs. Please find attached the following documents for your review: - Template for normal and asynchronous CloudStack API references. - Sample API reference page using the template for a CloudStack API (listZones). Please review this template and let me know your thoughts on this. Thanks, Rajsekhar api-reference-template-version1.docx Description: MS-Word 2007 document listZones-sample-api.docx Description: MS-Word 2007 document
Re: [Proposal] Template for CloudStack API Reference Pages
Thanks. Format is to domonstrate the usage of the API. I think that the format along with an example would help users understand how they can use the API. For example, the migrateto parameter in the API has the following format: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. An example for this format is: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc> Thanks, Rajsekhar On Wed, Nov 11, 2015 at 10:40 AM, Daejuan Jacobs wrote: > I assume by "Format" you mean data type. > > But I think this looks good. It's simple, yet it manages to nail all the > points you need when developing on a software's API. > > On Tue, Nov 10, 2015 at 8:33 AM Rajsekhar K > wrote: > > > Hi, All, > > > > This is the proposal for a new template for CloudStack API reference > > pages. This template is based on the reference page templates for REST > APIs. > > > > Please find attached the following documents for your review: > > > >- Template for normal and asynchronous CloudStack API references. > >- Sample API reference page using the template for a CloudStack API > >(listZones). > > > > > > Please review this template and let me know your thoughts on this. > > > > Thanks, > > Rajsekhar > > >
Re: [Proposal] Template for CloudStack API Reference Pages
Hi, Yiping, Thanks for your suggestions. I have updated the template based on your suggestions. Please find attached the updated template for your reference. I agree with your suggestion on proof-reading the descriptions. This is an important part of ensuring effective API references. I think the developers can do a peer review of the descriptions before they create a PR for reviewing and checking in the API descriptions. I hope we will have clarity on the target release soon. Thanks, Rajsekhar On Wed, Nov 11, 2015 at 11:46 PM, Yiping Zhang wrote: > As a user who uses API a lot, I would like to see following improvements > in api reference pages: > > 1) In brief description for Title section, please specify if the > referenced API is async or not. Currently, this info is available only on > the API listing pages with “(A)” after the api name, but not available or > obvious anywhere on the api reference page itself. > > 2) For each parameter, in addition to , , > attributes, it would be great to also provide following: > := integer | string | array | enumerate | boolean etc > := true | false | null | 0 etc > > A Notes subsection for parameters: IMHO, there are several reasons > that such a section will be useful: > * A list of values which have special meaning to the api and what > are their special meanings, if any. For example, for listVirtualMachines > api, projectid=-1 would return instances belonging to ALL projects. Here > value “-1” is special. > * combination of certain parameters are mutually exclusive, or are > required. Some of this info are currently present in the parameter’s > description field. But they are usually too brief, hard to read and hard to > understand. > > > 3) Add a limitations section: >This section describes scenarios where the referenced API does not > apply to, or not implemented yet, or known to not work properly. Many apis > have limitations and the information is scattered all over places in > documents, if exists at all. So most often users can only find out by trial > and errors. > > For example, assignVirtualMachine api has following limitations: 1) > does not work with VM instances belonging to a project, 2) not implemented > for Advanced networking with security group enabled. > > 4) Add an Authorization section or just provide info on the page > somewhere: describe who can make this api call: root admin, domain admin, > or regular users. Currently, this info is provided by listing available > apis in different pages titled “Root admin API”, “domain admin api” and > “User api”. Personally, I prefer a separate section on each api’s > reference page for this info so that it can’t be missed. > > 5) Error response: I really like the idea of adding this section to the > reference page. Please list both HTTP response code as well as CloudStack > internal error code and error messages. > > > > > Finally, please get some one to proof-read all descriptions. Some of > current API document are really hard to understand! > > BTW: which release is this proposal targeted for ? > > Just my $0.02. > > Yiping > > > On 11/10/15, 9:10 PM, "Daejuan Jacobs" wrote: > > >I assume by "Format" you mean data type. > > > >But I think this looks good. It's simple, yet it manages to nail all the > >points you need when developing on a software's API. > > > >On Tue, Nov 10, 2015 at 8:33 AM Rajsekhar K > >wrote: > > > >> Hi, All, > >> > >> This is the proposal for a new template for CloudStack API reference > >> pages. This template is based on the reference page templates for REST > APIs. > >> > >> Please find attached the following documents for your review: > >> > >>- Template for normal and asynchronous CloudStack API references. > >>- Sample API reference page using the template for a CloudStack API > >>(listZones). > >> > >> > >> Please review this template and let me know your thoughts on this. > >> > >> Thanks, > >> Rajsekhar > >> > api-reference-template-version2.docx Description: MS-Word 2007 document
Improving API reference pages
Hi, All, This is part of our effort to improve user experience of Cloudstack/CloudPlatform API reference pages. Majority of the CloudStack/CloudPlatform API reference pages do not adequately describe the usage of the parameters associated with them. Many of these parameters contain only a single line description, which does not really enhance the user's experience with these APIs. CloudPlatform had received a few documentation tickets on this, with requests to improve the description, add information on the format, and an example on how to use the parameter. One of the tickets was on the *migrateto *parameter in the *migrateVirtualMachineWithVolume* API reference page. We have improved the description of the *migrateto *parameter as follows: *Parameter* *Description* *Required* *migrateto* Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc> False (This will be updated in the *migrateVirtualMachineWithVolume* API reference page of CloudStack soon.) I think I can take this as a base and improve the descriptions of the parameters in the CloudStack/Cloudplatform API reference pages. As an initial step, I have identified the following 20 API functions and I am planning to improve the description of the parameters in their reference pages: - *listAccounts * - *listCapacity * - *listLoadBalancerRules * - *listNetworks * - *listPublicIpAddresses * - *listSnapshots * - *listTemplates * - *listVirtualMachines * - *listVolumes * - *listZones * - *stopVirtualMachine * - *associateIPAddress * - *attachVolume * - *createSnapshot * - *startVirtualMachine * - *deployVirtualMachine * - *migrateVirtualMachineWithVolume * - *login * - *logout * - *updateVirtualMachine* Could you please provide your thoughts on this suggestion? Also, please let me know how you can help/contribute in this effort. Regards, Rajsekhar
Improving descriptions in the API reference pages
Hi, All, This is part of our effort to improve user experience of Cloudstack API reference pages. Majority of the CloudStack API reference pages do not adequately describe the usage of the parameters associated with them. Many of these parameters contain only a single line description, which does not really enhance the user's experience with these APIs. As part of this content improvement effort, I need to improve the description, add information on the format, and an example on how to use the parameter. Please find attached the improved content for the "migrateto" parameter in the 'migrateVirtualMachineWithVolume' API reference page as an example. I think I can take the description for the "migrateto" parameter as a base and improve the descriptions of the parameters in the CloudStack API reference pages. As an initial step, I have identified the following 20 API functions and I am planning to improve the description of the parameters available in their reference pages: * listAccounts * listCapacity * listLoadBalancerRules * listNetworks * listPublicIpAddresses * listSnapshots * listTemplates * listVirtualMachines * listVolumes * listZones * stopVirtualMachine * associateIPAddress * attachVolume * createSnapshot * startVirtualMachine * deployVirtualMachine * migrateVirtualMachineWithVolume * login * logout * updateVirtualMachine Could you please provide your thoughts on this suggestion? Also, please let me know how you can help/contribute in this effort. Regards, Rajsekhar migrateto.docx Description: MS-Word 2007 document
Re: [DISCUSS] Improving API reference pages
Hi, Dave, Somesh,
Thanks for your feedback. Thanks for the help that you promised on this
task.
Hi, Dave,
Thanks for providing the Style Guide for the API Guides and some good
pointers on improving the API content. This is helpful.
Hi, Somesh,
Thanks for your willingness to help with the content.
I will use the information that you shared with me to create an efficient
plan for improving content for the 20 APIs that I listed in my earlier
email. Will get back to all of you with my plan for this task soon.
Regards,
Rajsekhar
On Mon, Aug 3, 2015 at 9:28 PM, Somesh Naidu
wrote:
> {should you be adding [DISCUSS] and/or [PROPOSAL] to the subject?}
>
> +1
>
> Definitely required. Improvements in description/function required for
> both the API call itself and associated parameters. I am willing to help
> with the content.
>
> Regards,
> Somesh
>
>
> -Original Message-
> From: Dave Dunaway [mailto:dave.duna...@gmail.com]
> Sent: Monday, August 03, 2015 9:24 AM
> To: us...@cloudstack.apache.org
> Cc: dev@cloudstack.apache.org
> Subject: Re: Improving API reference pages
>
> I would definitely say this is needed. A few calls need to specify "types"
> of which there is not description or they are poorly worded.
>
> If the API doc page could have comments... that would be good too. Let the
> community add examples or suggestions.
>
> However the real deal is to document the attributes and return values for
> each call. Show a basic call using curl. Describe what the call does (some
> have no description). Like what most other sites with API's do :)
>
> Here's a "style" guide for API documentation creation... it seems pretty
> good.
>
> http://blog.parse.com/learn/engineering/designing-great-api-docs/
>
> HTH
>
> dave.
>
>
>
> On Mon, Aug 3, 2015 at 5:37 AM, Rajsekhar K
> wrote:
>
> > Hi, All,
> >
> > This is part of our effort to improve user experience of
> > Cloudstack/CloudPlatform API reference pages.
> >
> > Majority of the CloudStack/CloudPlatform API reference pages do not
> > adequately describe the usage of the parameters associated with them.
> Many
> > of these parameters contain only a single line description, which does
> not
> > really enhance the user's experience with these APIs.
> >
> > CloudPlatform had received a few documentation tickets on this, with
> > requests to improve the description, add information on the format, and
> an
> > example on how to use the parameter. One of the tickets was on the
> > *migrateto *parameter in the *migrateVirtualMachineWithVolume* API
> > reference page. We have improved the description of the *migrateto
> > *parameter
> > as follows:
> >
> > *Parameter*
> >
> > *Description*
> >
> > *Required*
> >
> > *migrateto*
> >
> > Storage to pool mapping. This parameter specifies the mapping between a
> > volume and a pool where you want to migrate that volume. Format of this
> > parameter:
> >
> >
> migrateto[volume-index].volume=&migrateto[volume-index].pool=Where,
> > [volume-index] indicates the index to identify the volume that you want
> to
> > migrate, volume= indicates the UUID of the volume that you want to
> > migrate, and pool= indicates the UUID of the pool where you want to
> > migrate the volume. Example:
> >
> >
> migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>
> >
> > False
> >
> > (This will be updated in the *migrateVirtualMachineWithVolume* API
> > reference page of CloudStack soon.)
> >
> > I think I can take this as a base and improve the descriptions of the
> > parameters in the CloudStack/Cloudplatform API reference pages. As an
> > initial step, I have identified the following 20 API functions and I am
> > planning to improve the description of the parameters in their reference
> > pages:
> >
> >
> >-
> > *listAccounts *
> >-
> > *listCapacity *
> >-
> > *listLoadBalancerRules *
> >-
> > *listNetworks *
> >-
> > *listPublicIpAddresses *
> >-
> > *listSnapshots *
> >-
> > *listTemplates *
> >-
> > *listVirtualMachines *
> >-
> > *listVolumes *
> >-
> > *listZones *
> >-
> > *stopVirtualMachine *
> >-
> > *associateIPAddress *
> >-
> > *attachVolume *
> >-
> > *createSnapshot *
> >-
> > *startVirtualMachine *
> >-
> > *deployVirtualMachine *
> >-
> > *migrateVirtualMachineWithVolume *
> >-
> > *login *
> >-
> > *logout *
> >- *updateVirtualMachine*
> >
> > Could you please provide your thoughts on this suggestion? Also, please
> let
> > me know how you can help/contribute in this effort.
> >
> > Regards,
> > Rajsekhar
> >
>
Update docs using reStructuredText - Need help
Hi, I want to update information in the Downloading vhd-util section of the Installation Guide (version 4.6). Would like to know how I can access the Install Guide files that I can edit using reStructuredText. I have installed Sphinx and can access Online reStructuredText editor (http://rst.ninjs.org/). I think I know the process for creating pull requests on updating the .xml source files. I would like to know how the process differs when I use reStructuredText. Could you please help? Thanks, Rajsekhar K Senior Product Engineer | Accelerite, Bangalore Email: rajsekha...@accelerite.com<mailto:rajsekha...@accelerite.com> DISCLAIMER == This e-mail may contain privileged and confidential information which is the property of Accelerite, a Persistent Systems business. It is intended only for the use of the individual or entity to which it is addressed. If you are not the intended recipient, you are not authorized to read, retain, copy, print, distribute or use this message. If you have received this communication in error, please notify the sender and delete all copies of this message. Accelerite, a Persistent Systems business does not accept any liability for virus infected mails.
RE: [Discuss] CloudStack documentation
Hi, All, I agree with Dag Sonstebo that we need to improve the layout and navigation of CloudStack documentation. I think that the improvement should begin from the home page. New users may not find the way the information presented on the home page very intuitive. A few tweaking on the home page will help us improve the information experience of CloudStack users. Here are my thoughts on improving CloudStack documentation: • Our users - mostly experienced administrators- would install CloudStack and understand the basic concepts, deployment architecture, and terminologies first. After doing this, they would be delighted to see the big picture of the tasks that they can do with CloudStack. So, a home page for CloudStack documentation that displays the big picture of the tasks that the users can do with CloudStack will be appreciated. We can display the big picture of the tasks in distinct content blocks on the Home page. Each block will have a link to the documentation and a brief description of the major task. Users will click the link to the documentation to land on the page for that major task. They can, now, see the ToC for the major ask. This ToC will delineate the flow of minor (sub) tasks that constitute the major task. • It is useful if we can incorporate videos and lectures on the Home page. Professionally made videos will be very helpful to the users. • I think we need to think beyond 'guides' (such as Installation Guide, Administration Guide, and so on) when we present the information online. CloudStack users would be delighted to see a topic that directly answers the question in their mind (such as 'Configuring a XenServer host with CloudStack') than logically locating a help topic by navigating to a guide first, then to a section in the guide and then locating the information. They would be able to access and read the documentation in non-linear manner. • Let's ensure that the information on upgrading CloudStack is available distinctly on the Home page. This will help avoid directing the users, who want to upgrade to the next CloudStack version, to the Installation section. Installation section can cater to the users who want to install CloudStack in their environment. • I think the home page should highlight the link to API reference pages. Also, I feel that we must improve CloudStack API reference pages by incorporating more useful information to each page. Based on the discussions that we had in the community sometime back, I have created a specification document and a template for API references at: https://cwiki.apache.org/confluence/display/CLOUDSTACK/Improving+CloudStack+API+References+-+Specifications • We can consolidate all matrixes at one location. Along with compatibility matrix, we need to identify information that we can present as matrix. The users should be able to access all these information from the documentation home page. • I would like to mention the effort that we have started on creating a reference book for the CloudStack configuration parameters. I hope, this will enhance the information experience of CloudStack users by educating them about the parameters that they can use for configuring CloudStack. I have published some initial information in the following cwiki pages and am awaiting thoughts/reviews from the community members: o Apache CloudStack Configuration Parameters Reference Guide - Tasks and Status - https://cwiki.apache.org/confluence/display/CLOUDSTACK/Apache+CloudStack+Configuration+Parameters+Reference+Guide+-+Tasks+and+Status o Configuration Parameters in Apache CloudStack - Categorization - https://cwiki.apache.org/confluence/display/CLOUDSTACK/Configuration+Parameters+in+Apache+CloudStack+-+Categorization o direct.agent.load.size (sample topic) - https://cwiki.apache.org/confluence/display/CLOUDSTACK/direct.agent.load.size Also, I think it is a good idea to educate the contributors about creating/updating the CloudStack documentation using reStructured Text. I am facing an issue on this. I want to update some information in the Install Guide, but I could not find guidelines on locating the correct files that I need to update. Clear instruction on this will be helpful. I will discuss these points with my colleague Sowmya Krishnan, who will be attending the CloudStack conference at Montreal. Regards, Rajsekhar K Senior Product Engineer | Accelerite, Bangalore Email: rajsekha...@accelerite.com<mailto:rajsekha...@accelerite.com> -Original Message- From: Ron Wheeler [mailto:rwhee...@artifact-software.com] Sent: Thursday, May 19, 2016 6:17 PM To: dev@cloudstack.apache.org Subject: Re: [Discuss] CloudStack documentation Identify where most issues are raised in the ML and fix the docs to reduce the confusion. I suspect that Networking is the source of most problems but perhaps other hav
Create/edit permissions for ACS wiki
Hi, I do not have permissions to create/edit pages at < https://cwiki.apache.org/confluence/display/CLOUDSTACK/> . Could you please help me get these permissions? My user name for this wiki is 'rajsekharkpally'. Thanks in advance for your help. Thanks, Rajsekhar
Re: Create/edit permissions for ACS wiki
Thanks, Daan. Thanks, Rajsekhar On Sun, Mar 13, 2016 at 2:10 AM, Daan Hoogland wrote: > On Fri, Mar 11, 2016 at 10:42 AM, Rajsekhar K > wrote: > > > rajsekharkpally > > > is in > > > > -- > Daan >
Re: [PROPOSAL] - Reference Guide for CloudStack configuration parameters
Thanks, Pierre-Luc. I think we can create a new Reference Guide with this information, which will be a single point of reference to learn about the Apache CloudStack configuration parameters. I think we can use the wiki for collaborating on this document. I think the wiki will be helpful in sharing our thoughts, collecting input, and reviewing the content. Thanks, Rajsekhar On Mon, Feb 22, 2016 at 9:36 PM, Pierre-Luc Dion wrote: > Good Initiative Rajsekhar ! > > I think this document should go into the admin-guide [1]. For sure the wiki > is easier to start with :-) > > Thanks ! > > PL > > > On Tue, Feb 16, 2016 at 4:49 AM, Rajsekhar K > wrote: > > > Hi, All, > > > > Thanks for your responses. I am sure we will be able to create a complete > > reference guide for the CloudStack parameters. > > > > I think I can create a wiki page that explains this effort and publish > this > > list of categories there. I think it will be easier for you to review the > > list then. > > > > Will let you know after I create this wiki page. > > > > Thanks, > > Rajsekhar > > > > On Mon, Feb 15, 2016 at 5:07 PM, Daan Hoogland > > wrote: > > > > > I like the idea but shouldn't it be part of the source code and > extracted > > > from there? What is the need to have it in a separate wiki? > > > > > > On Mon, Feb 15, 2016 at 9:18 AM, Rohit Yadav < > rohit.ya...@shapeblue.com> > > > wrote: > > > > > > > Nice, maybe put this on our cwiki so others can collaborate than do > > this > > > > over a word doc? > > > > > > > > Regards. > > > > > > > > > > > > [image: ShapeBlue] <http://www.shapeblue.com> > > > > Rohit Yadav > > > > Software Architect , ShapeBlue > > > > d: * | s: +44 203 603 0540* <%7C%20s:%20+44%20203%20603%200540> | > > m: > > > > *+91 8826230892* <+91%208826230892> > > > > e: *rohit.ya...@shapeblue.com | t: * > > > > | w: *www.shapeblue.com* > > > > <http://www.shapeblue.com> > > > > a: 53 Chandos Place, Covent Garden London WC2N 4HS UK > > > > Shape Blue Ltd is a company incorporated in England & Wales. > ShapeBlue > > > > Services India LLP is a company incorporated in India and is operated > > > under > > > > license from Shape Blue Ltd. Shape Blue Brasil Consultoria Ltda is a > > > > company incorporated in Brasil and is operated under license from > Shape > > > > Blue Ltd. ShapeBlue SA Pty Ltd is a company registered by The > Republic > > of > > > > South Africa and is traded under license from Shape Blue Ltd. > ShapeBlue > > > is > > > > a registered trademark. > > > > This email and any attachments to it may be confidential and are > > intended > > > > solely for the use of the individual to whom it is addressed. Any > views > > > or > > > > opinions expressed are solely those of the author and do not > > necessarily > > > > represent those of Shape Blue Ltd or related companies. If you are > not > > > the > > > > intended recipient of this email, you must neither take any action > > based > > > > upon its contents, nor copy or show it to anyone. Please contact the > > > sender > > > > if you believe you have received this email in error. > > > > > > > > > > > > On 14-Feb-2016, at 5:37 AM, Rajsekhar K > > > wrote: > > > > > > > > Hi, All, > > > > > > > > This is part of the effort to create a Reference Guide for CloudStack > > > > configuration parameters. This guide intends to provide a single > point > > of > > > > reference for the configuration parameters that we use in CloudStack. > > > Each > > > > parameter will be treated as a topic in this guide. > > > > > > > > I am planning to document the following information for each > parameter: > > > > > > > > > > > >- Name and description of the parameter. > > > >- List of features that the users can configure using the > parameter. > > > >- Changes in the behavior of each parameter when users provide > low, > > > >optimal, and high values to the parameters. > > > >- Warnings, notes, and limitations for each parameter. > > > >- Example for each parameter - Explaining the p
Re: [PROPOSAL] - Reference Guide for CloudStack configuration parameters
Hi, All, Please find the wiki page for Apache CloudStack Configuration Parameter Reference Guide at: *Apache CloudStack Configuration Parameters Reference Guide - Tasks and Status* <https://cwiki.apache.org/confluence/display/CLOUDSTACK/Apache+CloudStack+Configuration+Parameters+Reference+Guide+-+Tasks+and+Status>. This wiki describes the information that we need to document for this Reference Guide. Also, please find the parameters categorized based on their function at: *Configuration Parameters in Apache CloudStack - Categorization* <https://cwiki.apache.org/confluence/display/CLOUDSTACK/Configuration+Parameters+in+Apache+CloudStack+-+Categorization>. Please review this categorization and share your thoughts. The parameters that are grouped under *Others* are not categorized. Could you help me categorize these parameters? Thanks, Rajsekhar On Mon, Mar 14, 2016 at 4:06 PM, Rajsekhar K wrote: > Thanks, Pierre-Luc. > > I think we can create a new Reference Guide with this information, which > will be a single point of reference to learn about the Apache CloudStack > configuration parameters. I think we can use the wiki for collaborating on > this document. I think the wiki will be helpful in sharing our thoughts, > collecting input, and reviewing the content. > > Thanks, > Rajsekhar > > On Mon, Feb 22, 2016 at 9:36 PM, Pierre-Luc Dion > wrote: > >> Good Initiative Rajsekhar ! >> >> I think this document should go into the admin-guide [1]. For sure the >> wiki >> is easier to start with :-) >> >> Thanks ! >> >> PL >> >> >> On Tue, Feb 16, 2016 at 4:49 AM, Rajsekhar K >> wrote: >> >> > Hi, All, >> > >> > Thanks for your responses. I am sure we will be able to create a >> complete >> > reference guide for the CloudStack parameters. >> > >> > I think I can create a wiki page that explains this effort and publish >> this >> > list of categories there. I think it will be easier for you to review >> the >> > list then. >> > >> > Will let you know after I create this wiki page. >> > >> > Thanks, >> > Rajsekhar >> > >> > On Mon, Feb 15, 2016 at 5:07 PM, Daan Hoogland > > >> > wrote: >> > >> > > I like the idea but shouldn't it be part of the source code and >> extracted >> > > from there? What is the need to have it in a separate wiki? >> > > >> > > On Mon, Feb 15, 2016 at 9:18 AM, Rohit Yadav < >> rohit.ya...@shapeblue.com> >> > > wrote: >> > > >> > > > Nice, maybe put this on our cwiki so others can collaborate than do >> > this >> > > > over a word doc? >> > > > >> > > > Regards. >> > > > >> > > > >> > > > [image: ShapeBlue] <http://www.shapeblue.com> >> > > > Rohit Yadav >> > > > Software Architect , ShapeBlue >> > > > d: * | s: +44 203 603 0540* <%7C%20s:%20+44%20203%20603%200540> | >> > m: >> > > > *+91 8826230892* <+91%208826230892> >> > > > e: *rohit.ya...@shapeblue.com | t: * >> > > > | w: *www.shapeblue.com* >> > > > <http://www.shapeblue.com> >> > > > a: 53 Chandos Place, Covent Garden London WC2N 4HS UK >> > > > Shape Blue Ltd is a company incorporated in England & Wales. >> ShapeBlue >> > > > Services India LLP is a company incorporated in India and is >> operated >> > > under >> > > > license from Shape Blue Ltd. Shape Blue Brasil Consultoria Ltda is a >> > > > company incorporated in Brasil and is operated under license from >> Shape >> > > > Blue Ltd. ShapeBlue SA Pty Ltd is a company registered by The >> Republic >> > of >> > > > South Africa and is traded under license from Shape Blue Ltd. >> ShapeBlue >> > > is >> > > > a registered trademark. >> > > > This email and any attachments to it may be confidential and are >> > intended >> > > > solely for the use of the individual to whom it is addressed. Any >> views >> > > or >> > > > opinions expressed are solely those of the author and do not >> > necessarily >> > > > represent those of Shape Blue Ltd or related companies. If you are >> not >> > > the >> > > > intended recipient of this email, you must neither take any action >> > based >> > > >
FW: [PROPOSAL] - Reference Guide for CloudStack configuration parameters
Hi, All, I am still waiting for your review comments/thoughts on this categorization of configuration parameters. Thanks, Rajsekhar Kunnampally Senior Product Engineer | Accelerite, Bangalore Email: rajsekha...@accelerite.com<mailto:rajsekha...@accelerite.com> Hi, All, Please find the wiki page for Apache CloudStack Configuration Parameter Reference Guide at: Apache CloudStack Configuration Parameters Reference Guide - Tasks and Status<https://cwiki.apache.org/confluence/display/CLOUDSTACK/Apache+CloudStack+Configuration+Parameters+Reference+Guide+-+Tasks+and+Status>. This wiki describes the information that we need to document for this Reference Guide. Also, please find the parameters categorized based on their function at: Configuration Parameters in Apache CloudStack - Categorization<https://cwiki.apache.org/confluence/display/CLOUDSTACK/Configuration+Parameters+in+Apache+CloudStack+-+Categorization>. Please review this categorization and share your thoughts. The parameters that are grouped under Others are not categorized. Could you help me categorize these parameters? Thanks, Rajsekhar On Mon, Mar 14, 2016 at 4:06 PM, Rajsekhar K mailto:rajsekharkpa...@gmail.com>> wrote: Thanks, Pierre-Luc. I think we can create a new Reference Guide with this information, which will be a single point of reference to learn about the Apache CloudStack configuration parameters. I think we can use the wiki for collaborating on this document. I think the wiki will be helpful in sharing our thoughts, collecting input, and reviewing the content. Thanks, Rajsekhar On Mon, Feb 22, 2016 at 9:36 PM, Pierre-Luc Dion mailto:pd...@cloudops.com>> wrote: Good Initiative Rajsekhar ! I think this document should go into the admin-guide [1]. For sure the wiki is easier to start with :-) Thanks ! PL On Tue, Feb 16, 2016 at 4:49 AM, Rajsekhar K mailto:rajsekharkpa...@gmail.com>> wrote: > Hi, All, > > Thanks for your responses. I am sure we will be able to create a complete > reference guide for the CloudStack parameters. > > I think I can create a wiki page that explains this effort and publish this > list of categories there. I think it will be easier for you to review the > list then. > > Will let you know after I create this wiki page. > > Thanks, > Rajsekhar > > On Mon, Feb 15, 2016 at 5:07 PM, Daan Hoogland > mailto:daan.hoogl...@gmail.com>> > wrote: > > > I like the idea but shouldn't it be part of the source code and extracted > > from there? What is the need to have it in a separate wiki? > > > > On Mon, Feb 15, 2016 at 9:18 AM, Rohit Yadav > > mailto:rohit.ya...@shapeblue.com>> > > wrote: > > > > > Nice, maybe put this on our cwiki so others can collaborate than do > this > > > over a word doc? > > > > > > Regards. > > > > > > > > > [image: ShapeBlue] <http://www.shapeblue.com> > > > Rohit Yadav > > > Software Architect , ShapeBlue > > > d: * | s: +44 203 603 0540* <%7C%20s:%20+44%20203%20603%200540> | > m: > > > *+91 8826230892* <+91%208826230892> > > > e: *rohit.ya...@shapeblue.com<mailto:rohit.ya...@shapeblue.com> | t: * > > > mailto:rohit.ya...@shapeblue.com>%20%7C%20t:> > > > | w: *www.shapeblue.com<http://www.shapeblue.com>* > > > <http://www.shapeblue.com> > > > a: 53 Chandos Place, Covent Garden London WC2N 4HS UK > > > Shape Blue Ltd is a company incorporated in England & Wales. ShapeBlue > > > Services India LLP is a company incorporated in India and is operated > > under > > > license from Shape Blue Ltd. Shape Blue Brasil Consultoria Ltda is a > > > company incorporated in Brasil and is operated under license from Shape > > > Blue Ltd. ShapeBlue SA Pty Ltd is a company registered by The Republic > of > > > South Africa and is traded under license from Shape Blue Ltd. ShapeBlue > > is > > > a registered trademark. > > > This email and any attachments to it may be confidential and are > intended > > > solely for the use of the individual to whom it is addressed. Any views > > or > > > opinions expressed are solely those of the author and do not > necessarily > > > represent those of Shape Blue Ltd or related companies. If you are not > > the > > > intended recipient of this email, you must neither take any action > based > > > upon its contents, nor copy or show it to anyone. Please contact the > > sender > > > if you believe you have received this email in error. > > > > > > > > > On 14-Feb-2016, at 5:37 AM, Rajsekhar K > > > mai
