Skip to content

Pr refactor doc#474

Merged
k8s-ci-robot merged 8 commits intokubernetes-sigs:masterfrom
sbueringer:pr-refactor-doc
Oct 1, 2019
Merged

Pr refactor doc#474
k8s-ci-robot merged 8 commits intokubernetes-sigs:masterfrom
sbueringer:pr-refactor-doc

Conversation

@sbueringer
Copy link
Member

Final doc pr before v0.2.0.

I tried to shorten the documentation a bit, because to be honest we're not able to keep that much documentation up-to-date. Most of the previous documentation was easily accessible by taking a quick glimpse into the code. Also there will be a lot more documentation from the Cluster API project itself (https://cluster-api.sigs.k8s.io). I will also add a PR in the main repo in the week or so to add the OpenStack provider to the quickstart.

Fixes #380

P.S. I would like to create the release after this PR is merged, but I will open another issue for this.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 23, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 23, 2019
@k8s-ci-robot k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Sep 23, 2019
@sbueringer sbueringer mentioned this pull request Sep 23, 2019
@sbueringer
Copy link
Member Author

/assign @jichenjc
/assign @hidekazuna
/assign @prankul88

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 23, 2019
@k8s-ci-robot
Copy link
Contributor

@sbueringer: GitHub didn't allow me to assign the following users: prankul88.

Note that only kubernetes-sigs members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

Details

In response to this:

/assign @jichenjc
/assign @hidekazuna
/assign @prankul88

/hold

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

||Cluster API v1alpha1 (v0.1)|Cluster API v1alpha2 (v0.2)|
|-|-|-|
|OpenStack Provider v1alpha1 (release-0.1 branch)|✓||
|OpenStack Provider v1alpha2 (v0.2)||✓|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we say master instead of v0.2? or v0.2 branch?

Copy link
Member Author

@sbueringer sbueringer Sep 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because I wanted to release 0.2.0 based on v1alpha2 and we shouldn't branch away a release-0.2 before v1alpha3 I would like to keep 0.2 (see also: https://github.com/kubernetes-sigs/cluster-api-provider-aws#compatibility-with-cluster-api-and-kubernetes-versions (their list is not up-to-date))

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, then why we need v0.2 ? as master actually works fine and we can have release-0.2 when v1alpha3 out..

Copy link
Member Author

@sbueringer sbueringer Sep 25, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0.2 stands for the tags 0.2.0, 0.2.1, etc.. I think it's more precise to say CAPO 0.2 then something on the master branch. And it's the same as CAPA is doing. If we don't want to release then master would be the only option. But I think when we're doing releases it's far better to tell our users which release supports what, so they don't have to figure out which release comes from which branch.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

0.2 stands for the tags make sense to me.

README.md Outdated
|-|-|-|-|-|
|OpenStack Provider v1alpha1 (ea309e7f)|✓|✓|✓|✓|
|OpenStack Provider v1alpha1 (release-0.1 branch)|✓|✓|✓|✓|
|OpenStack Provider v1alpha2 (v0.2)|✓|✓|✓|✓|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

technically we can say we support v0.2 on P/Q/R, but we haven't try P/Q/R on v0.2, correct?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, no idea what we can put here. We didn't really change the code from 0.1 in this regard. I personally only tried it on Queens (and on @chrigl 's OpenStack, not sure which version it is)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I remove all checkmarks except Queens?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My environments is Stein, installed according to OpenStack community installation guide.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the table to reflect what should work and what's actually tested

OpenStack Pike OpenStack Queens OpenStack Rocky OpenStack Stein
OpenStack Provider v1alpha1 (release-0.1 branch)
OpenStack Provider v1alpha2 (v0.2) + +

Key:

  • tested
  • + should work, but we weren't able to test it

**NOTE**: Because the user is able to customize any `user-data`, it is also possible to deploy older versions.
But we won't provide any examples or working templates. See [user-data in the examples](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/tree/master/cmd/clusterctl/examples/openstack/provider-component/user-data).
|OpenStack Provider v1alpha1 (release-0.1 branch)|✓|✓|✓|
|OpenStack Provider v1alpha2 (v0.2)|||✓|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

master branch or v0.2 branch will be better? v0.2 seems a tag..

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above 0.2 stands for all our 0.2.x releases (which will be tags)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto..

@sbueringer
Copy link
Member Author

PTAL @jichenjc @hidekazuna

@sbueringer sbueringer mentioned this pull request Sep 25, 2019
2 tasks
@sbueringer
Copy link
Member Author

@jichenjc @hidekazuna Can I get a /lgtm to get this merged? :)

@sbueringer
Copy link
Member Author

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 1, 2019
@hidekazuna
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 1, 2019
@k8s-ci-robot k8s-ci-robot merged commit c6ff3fd into kubernetes-sigs:master Oct 1, 2019
@sbueringer sbueringer deleted the pr-refactor-doc branch October 6, 2019 12:08
pierreprinetti pushed a commit to shiftstack/cluster-api-provider-openstack that referenced this pull request Apr 22, 2024
* update release doc, fix manager image tag

* update doc

* fixed typo

* review fixes

* review

* review

* review fix

* update Openstack support table
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[v1alpha2]: prepare for v1alpha2 adoption

5 participants