Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added new docs for huaweicloud cpi #568

Conversation

@zhongjun2
Copy link

zhongjun2 commented Sep 4, 2018

No description provided.

zhongjun2 added 4 commits Sep 4, 2018
@cfdreddbot

This comment has been minimized.

Copy link

cfdreddbot commented Sep 4, 2018

Hey zhongjun2!

Thanks for submitting this pull request!

All pull request submitters and commit authors must have a Contributor License Agreement (CLA) on-file with us. Please have everyone sign the appropriate CLA (individual or corporate), and send to: contributors@cloudfoundry.org.

When sending a signed CLA please provide your github username in case of an individual CLA or the list of github usernames that can make pull requests on behalf of your organization.

The following github user @zhongjun2 has not signed the appropriate CLA.

If you are confident that everyone listed is covered under a Corporate CLA, please make sure everyone has publicized their membership in the appropriate Github Org, per these instructions.

Once everyone has publicized their membership, one of the owners of this repository can close and reopen this pull request, and dreddbot will take another look.

@cf-gitbot

This comment has been minimized.

Copy link

cf-gitbot commented Sep 4, 2018

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/160249486

The labels on this github issue will be updated when the story is started.

@zhongjun2 zhongjun2 changed the title [New cpi] added new doc for huaweicloud cpi Added new docs for huaweicloud cpi Sep 4, 2018
```
If running above commands outside of an HuaweiCloud VPC, refer to [Exposing environment on a public IP](init-external-ip.md) for additional CLI flags.
See [HuaweiCloud CPI errors](HuaweiCloud-cpi-errors.md) for list of common errors and resolutions.

This comment has been minimized.

Copy link
@gberche-orange

gberche-orange Sep 5, 2018

Contributor

The HuaweiCloud-cpi-errors.md page seems missing from the PR ?

This comment has been minimized.

Copy link
@zhongjun2

zhongjun2 Sep 6, 2018

Author

Done Thanks

zhongjun2 added 3 commits Sep 6, 2018
@mfine30

This comment has been minimized.

Copy link
Member

mfine30 commented Sep 25, 2018

Hey @zhongjun2 happy to take a look at this and start reviewing. Before we merge it though, can you please sign the CLA referenced in the above comment and then close and reopen this PR?

@zhongjun2

This comment has been minimized.

Copy link
Author

zhongjun2 commented Sep 26, 2018

Hi mfine30, Thanks for your remind. I just signed the CLA. I am waiting for it pass.

@zhongjun2 zhongjun2 closed this Sep 27, 2018
@zhongjun2 zhongjun2 reopened this Sep 27, 2018
@cfdreddbot

This comment has been minimized.

Copy link

cfdreddbot commented Sep 27, 2018

Hey zhongjun2!

Thanks for submitting this pull request! I'm here to inform the recipients of the pull request that you and the commit authors have already signed the CLA.

@cf-gitbot cf-gitbot removed the unscheduled label Sep 27, 2018
@cf-gitbot

This comment has been minimized.

Copy link

cf-gitbot commented Sep 27, 2018

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/160810717

The labels on this github issue will be updated when the story is started.

Copy link
Contributor

jrussett left a comment

@zhongjun2, we've been reviewing this doc and have found two immediate problems:

Problem 1:

Currently the doc pages are not visible/explorable without adding them to mkdocs.yml. Once you have added references in this YAML file, your docs will be searchable and there will be generated links to them in the table of contents.
Specifically, you'll need to change these two sections to contain the HuaweiCloud pages:

init docs

docs-bosh/mkdocs.yml

Lines 16 to 26 in 7695cce

- Installation:
- Installing the CLI: cli-v2-install.md
- Quick Start: quick-start.md
- Amazon Web Services: init-aws.md
- Google Cloud Platform: init-google.md
- Microsoft Azure: init-azure.md
- OpenStack: init-openstack.md
- SoftLayer: init-softlayer.md
- VirtualBox: bosh-lite.md
- VMware vCloud: init-vcloud.md
- VMware vSphere: init-vsphere.md

cpi docs:

docs-bosh/mkdocs.yml

Lines 216 to 226 in 7695cce

- Amazon Web Services:
- Overview: aws.md
- Usage: aws-cpi.md
- Common Errors: aws-cpi-errors.md
- IAM Users: aws-iam-users.md
- IAM Profiles: aws-iam-instance-profiles.md
- Using Instance Storage: aws-instance-storage.md
- Google Cloud Platform:
- Overview: google.md
- Usage: google-cpi.md
- Required Permissions: google-required-permissions.md

Problem 2

Another issue is that your documents are formatted incorrectly. We previewed init-huaweicloud.md and the top header and paragraphs looked like:
screen shot 2018-10-04 at 2 47 06 pm

You should be able to preview the changes that you're making by executing the following commands:

cd docs-bosh
git submodule update --init --recursive --force
docker run --rm -it -p 8000:8000 -v "${PWD}:/docs" squidfunk/mkdocs-material:2.7.2

And then you can visit http://localhost:8000/init-huaweicloud/, http://localhost:8000/huaweicloud-cpi/, etc... to make sure that all of the documents appear correctly.

Best,
@jrussett && @mikexuu, CF BOSH


---
## Global Configuration {: #global }

This comment has been minimized.

Copy link
@jrussett

jrussett Oct 4, 2018

Contributor

Could you please provide a schema for this global configuration section? Similarly to how keys in the cloud_properties have descriptions, it would be nice to have descriptions in these keys as well.

This comment has been minimized.

Copy link
@zhongjun2

zhongjun2 Oct 18, 2018

Author

Done in commit 12. Thanks


Schema for `cloud_properties` section used by dynamic network or manual network subnet:

* **subnet_id** [String, required]: Subnet ID belong to VPC and the instance will be created.

This comment has been minimized.

Copy link
@jrussett

jrussett Oct 4, 2018

Contributor

We found this sentence to be slightly unclear, do you mean more like something along the lines of: "Subnet ID in which the instances will be created" ?

<tr><td>All UDP</td><td>0 - 65535</td><td>ID of this security group</td><td>Management and data access</td></tr>
</table>
See [Creating a Security Group](https://www.alibabacloud.com/help/doc-detail/25468.htm)
See [Add security group rules](https://www.alibabacloud.com/help/doc-detail/25471.htm)

This comment has been minimized.

Copy link
@jrussett

jrussett Oct 4, 2018

Contributor

These links link to Alicloud's documentation. Is this intentional?

zhongjun2 added 4 commits Oct 18, 2018
Copy link
Contributor

mikexuu left a comment

Thanks for your fixes. We are still noticing some formatting issues on our end and have attached screenshots below.
Could you please look at these as well?

Thanks,
@s4heid && @mikexuu

screen shot 2018-10-19 at 12 11 56 pm

screen shot 2018-10-19 at 12 12 16 pm

@zhongjun2 zhongjun2 closed this Mar 28, 2019
@cf-gitbot cf-gitbot removed the unscheduled label Mar 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
7 participants
You can’t perform that action at this time.