Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upAdd documentation for inlets-operator #14
Conversation
|
Thank you for your interest in this project. Due to an unfortunate number of spam Pull Requests, all PRs from first-time If your PR is genuine, then please bear with us and we will get to your |
|
Not Spam |
|
Thanks for the PR, I'm going to turn Derek off for this org as we've not been bothered by Hacktoberfest spam :) |
|
Why is EC2 yet to be added? |
|
Does it just not exist in the upstream readme yet? I added steps for a service accounts the docs for inletsctl, which you can copy and adapt if you like? |
|
|
||
| > Note: this example is now multi-arch, so it's valid for `x86_64`, `ARMHF`, and `ARM64`. | ||
| You can also run the operator in-cluster, a ClusterRole is used since Services can be created in any namespace, and may need a tunnel. Install the inlets-operator using a single command with [arkade](https://get-arkade.dev/). arkade runs against any Kubernetes cluster and wraps the helm command-line. |
alexellis
Oct 17, 2020
Member
Remove You can also run the operator in-cluster,
Remove You can also run the operator in-cluster,
|
|
||
| View the code on GitHub: [inlets/inletsctl](https://github.com/inlets/inletsctl) | ||
|
|
||
| ## Using DigitalOcean for the exit node |
alexellis
Oct 17, 2020
Member
Can we change the titles to:
"Create exit-servers on DigitalOcean" and so forth?
Can we change the titles to:
"Create exit-servers on DigitalOcean" and so forth?
|
|
||
| inlets-operator adds public LoadBalancers to your local Kubernetes clusters. | ||
|
|
||
| View the code on GitHub: [inlets/inletsctl](https://github.com/inlets/inletsctl) |
alexellis
Oct 17, 2020
Member
I would link to inlets-operator, not inletsctl
I would link to inlets-operator, not inletsctl
| @@ -0,0 +1,160 @@ | |||
| # inlets-operator reference documentation | |||
|
|
|||
| inlets-operator adds public LoadBalancers to your local Kubernetes clusters. | |||
alexellis
Oct 17, 2020
Member
Please add one generic statement and example at the top showing inlets-operator installed with helm, and then one with arkade.
Please add one generic statement and example at the top showing inlets-operator installed with helm, and then one with arkade.
| --set provider=azure,region=eastus,subscriptionID=<Azure Subscription ID> | ||
| ``` | ||
|
|
||
| ## Using a provider which requires an Access Key and Secret Key? (AWS EC2, Scaleway) |
alexellis
Oct 17, 2020
Member
Should we just break these out into specific sections if they do not exist already?
Should we just break these out into specific sections if they do not exist already?
utsavanand2
Oct 17, 2020
Author
Contributor
Yes it is there in the ec2 example because ec2 needs the secret-key-file, so this section can be omitted.
Yes it is there in the ec2 example because ec2 needs the secret-key-file, so this section can be omitted.
7036a71
to
4e13962
|
@alexellis Does it look any better? |
|
LGTM |
|
Now just add your link in the main README on the homepage, then when it's merged, remove all the duplicated text from the inlets-operator README and link to here. Thanks for this |
|
@alexellis Happy to help! |
Signed-off-by: Utsav Anand <utsavanand2@gmail.com>
|
@alexellis I've resolved the merge conflicts. |
|
/remove label: invalid |
|
LGTM |
|
Merged. Please can you do the next part in the inlets-operator README? |
Signed-off-by: Utsav Anand utsavanand2@gmail.com
Adds the documentation for installing inlets-operator across DigitalOcean, EC2, GCE, Linode, and Azure
(EC2 is to be added yet)