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

Documentation for Ingress #6378

Merged
merged 1 commit into from
Jul 29, 2020

Conversation

inercia
Copy link
Contributor

@inercia inercia commented Jul 7, 2020

Documentation for Ingress

What type of PR is this?

/kind documentation

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 7, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @inercia. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 7, 2020
@k8s-ci-robot k8s-ci-robot requested review from EppO and floryut July 7, 2020 10:37
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 7, 2020
README.md Outdated Show resolved Hide resolved
docs/ambassador.md Outdated Show resolved Hide resolved
@floryut
Copy link
Member

floryut commented Jul 7, 2020

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 7, 2020
@inercia inercia force-pushed the inercia/ingress_docs branch 2 times, most recently from 1555dd8 to aa3622f Compare July 7, 2020 13:39
@floryut
Copy link
Member

floryut commented Jul 7, 2020

/lgtm

@inercia inercia requested a review from floryut July 7, 2020 13:40
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 7, 2020
@inercia
Copy link
Contributor Author

inercia commented Jul 7, 2020

/assign ant31

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@LuckySB
Copy link
Contributor

LuckySB commented Jul 7, 2020

@floryut sorry, but my link looks cooler ;)

@inercia inercia force-pushed the inercia/ingress_docs branch from aa3622f to c2ed299 Compare July 7, 2020 15:31
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 7, 2020
@inercia inercia requested a review from LuckySB July 7, 2020 15:31
@floryut
Copy link
Member

floryut commented Jul 7, 2020

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 7, 2020
@inercia
Copy link
Contributor Author

inercia commented Jul 10, 2020

These CI failures seem unrelated. Any way to retrigger CI @floryut ?

@floryut
Copy link
Member

floryut commented Jul 10, 2020

These CI failures seem unrelated. Any way to retrigger CI @floryut ?

Yes, done :)

@inercia
Copy link
Contributor Author

inercia commented Jul 10, 2020

@floryut @LuckySB it seems CI is green now 👍

README.md Outdated Show resolved Hide resolved
@inercia inercia force-pushed the inercia/ingress_docs branch from c2ed299 to 6322230 Compare July 14, 2020 08:20
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 14, 2020
@inercia inercia requested a review from Miouge1 July 14, 2020 08:21
@Miouge1
Copy link
Contributor

Miouge1 commented Jul 14, 2020

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: inercia, Miouge1

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

The pull request process is described here

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 Jul 14, 2020
Copy link
Contributor

@oomichi oomichi left a comment

Choose a reason for hiding this comment

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

/cc @oomichi

@@ -0,0 +1,32 @@

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You are right, maybe I should improve this document with an example of how to use Ambassador...

@k8s-ci-robot k8s-ci-robot requested a review from oomichi July 16, 2020 17:23
@@ -197,6 +198,12 @@ The choice is defined with the variable `kube_network_plugin`. There is also an
option to leverage built-in cloud provider networking instead.
See also [Network checker](docs/netcheck.md).

## Ingress Plugins

- [ambassador](docs/ambassador.md): the Ambassador Ingress Controller and API gateway.
Copy link
Contributor

Choose a reason for hiding this comment

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

I am wondering we can specify roles/kubernetes-apps/ingress_controller/ambassador/README.md instead of docs/ambassador.md

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it would be better to either link to an improved documentation about Ambassador in the docs or the external docs in getambassador.io, but I don't think there are any links to READMEs in this file...

@inercia inercia force-pushed the inercia/ingress_docs branch from 6322230 to bd92747 Compare July 17, 2020 16:22
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 17, 2020
@floryut
Copy link
Member

floryut commented Jul 20, 2020

@inercia do you have any pending changes left to do ?

Signed-off-by: Alvaro Saurin <alvaro.saurin@gmail.com>
@inercia inercia force-pushed the inercia/ingress_docs branch from bd92747 to 45442f9 Compare July 20, 2020 08:48
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 20, 2020
@inercia
Copy link
Contributor Author

inercia commented Jul 20, 2020

@inercia do you have any pending changes left to do ?

@floryut I'm done. I have included a very simple example of how to use an Ingress once AMbassador is installed in the documentation.

@inercia inercia requested review from EppO and oomichi July 23, 2020 14:54
@floryut
Copy link
Member

floryut commented Jul 29, 2020

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 29, 2020
@k8s-ci-robot k8s-ci-robot merged commit 0fa5a25 into kubernetes-sigs:master Jul 29, 2020
@inercia
Copy link
Contributor Author

inercia commented Jul 29, 2020

Thanks, @floryut @EppO @oomichi @Miouge1, for your time

@inercia inercia deleted the inercia/ingress_docs branch July 29, 2020 14:22
erulabs added a commit to kubesail/kubespray that referenced this pull request Jul 29, 2020
* 'master' of https://github.com/kubernetes-sigs/kubespray:
  Documentation for Ingress (kubernetes-sigs#6378)
  Fix ansible-lint E301 for commands fetching data (kubernetes-sigs#6465)
  Fix shellcheck url (kubernetes-sigs#6462)
  Fix ansible-lint E305 (kubernetes-sigs#6459)
  Fix ansible-lint E404 (kubernetes-sigs#6417)
  Update README.md and openstack.md (kubernetes-sigs#6455)
  Add noqa and disable .ansible-lint global exclusions (kubernetes-sigs#6410)
  Move healthz check to secure ports (kubernetes-sigs#6446)
  Update multus version & crio conf (kubernetes-sigs#6444)
  Fix remove etcd broken with etcdctl_api 3 (kubernetes-sigs#6448)
  update cinder csi manifests (kubernetes-sigs#6434)
  Update docker package to 19.03.12 (kubernetes-sigs#6439)
  * add proxy_env definition to remove_node.yml resolving kubernetes-sigs#6430 (kubernetes-sigs#6431)
LuckySB pushed a commit to southbridgeio/kubespray that referenced this pull request Sep 17, 2020
Signed-off-by: Alvaro Saurin <alvaro.saurin@gmail.com>
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. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants