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

Add documentation for inlets-operator #14

Merged
merged 1 commit into from Oct 18, 2020
Merged

Conversation

@utsavanand2
Copy link
Contributor

@utsavanand2 utsavanand2 commented Oct 17, 2020

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)

@derek derek bot added the new-contributor label Oct 17, 2020
@derek derek bot closed this Oct 17, 2020
@derek
Copy link

@derek derek bot commented Oct 17, 2020

Thank you for your interest in this project.

Due to an unfortunate number of spam Pull Requests, all PRs from first-time
contributors are assumed spam until we have a chance to review them.

If your PR is genuine, then please bear with us and we will get to your
change as soon as we can. In the meantime, you can make life easier for
us by commenting "Not Spam" and by checking your PR against the
contributing guidelines

@derek derek bot added the invalid label Oct 17, 2020
@utsavanand2
Copy link
Contributor Author

@utsavanand2 utsavanand2 commented Oct 17, 2020

Not Spam

@alexellis alexellis reopened this Oct 17, 2020
@alexellis
Copy link
Member

@alexellis alexellis commented Oct 17, 2020

Thanks for the PR, I'm going to turn Derek off for this org as we've not been bothered by Hacktoberfest spam :)

@alexellis
Copy link
Member

@alexellis alexellis commented Oct 17, 2020

Why is EC2 yet to be added?

@alexellis
Copy link
Member

@alexellis alexellis commented Oct 17, 2020

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.

This comment has been minimized.

@alexellis

alexellis Oct 17, 2020
Member

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

This comment has been minimized.

@alexellis

alexellis Oct 17, 2020
Member

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)

This comment has been minimized.

@alexellis

alexellis Oct 17, 2020
Member

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.

This comment has been minimized.

@alexellis

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.

--set provider=azure,region=eastus,subscriptionID=<Azure Subscription ID>
```

## Using a provider which requires an Access Key and Secret Key? (AWS EC2, Scaleway)

This comment has been minimized.

@alexellis

alexellis Oct 17, 2020
Member

Should we just break these out into specific sections if they do not exist already?

This comment has been minimized.

@utsavanand2

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.

@utsavanand2 utsavanand2 force-pushed the utsavanand2:master branch 2 times, most recently from 7036a71 to 4e13962 Oct 17, 2020
@utsavanand2
Copy link
Contributor Author

@utsavanand2 utsavanand2 commented Oct 17, 2020

@alexellis Does it look any better?

Copy link
Member

@alexellis alexellis left a comment

LGTM

@alexellis
Copy link
Member

@alexellis alexellis commented Oct 17, 2020

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 🍻

@utsavanand2 utsavanand2 force-pushed the utsavanand2:master branch from 4e13962 to 7c57e8d Oct 17, 2020
@utsavanand2
Copy link
Contributor Author

@utsavanand2 utsavanand2 commented Oct 17, 2020

@alexellis Happy to help!

Signed-off-by: Utsav Anand <utsavanand2@gmail.com>
@utsavanand2 utsavanand2 force-pushed the utsavanand2:master branch from 7c57e8d to 9b6b63f Oct 17, 2020
@utsavanand2
Copy link
Contributor Author

@utsavanand2 utsavanand2 commented Oct 17, 2020

@alexellis I've resolved the merge conflicts.

@alexellis
Copy link
Member

@alexellis alexellis commented Oct 18, 2020

/remove label: invalid

@derek derek bot removed the invalid label Oct 18, 2020
Copy link
Member

@alexellis alexellis left a comment

LGTM

@alexellis alexellis merged commit dcf3332 into inlets:master Oct 18, 2020
@alexellis
Copy link
Member

@alexellis alexellis commented Oct 18, 2020

Merged. Please can you do the next part in the inlets-operator README?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.