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

Adding README.md #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

same7ammar
Copy link

Adding a README guide for how to use this code before statring building it from scratch again.

@@ -0,0 +1,44 @@
# Simple Kubernetes controller

A simple controller that exposes your Kubernetes deployment automatically to external world. Please find youtube series .
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
A simple controller that exposes your Kubernetes deployment automatically to external world. Please find youtube series .
A simple controller that exposes your Kubernetes deployment automatically to external world. Please find youtube series.


## install using `manifests` folder

```python
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
```python
```bash

serviceaccount/ekspose-sa created
```

## status Checking .
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
## status Checking .
## Testing it, by creating a simple deployment

```

## status Checking .
1- create a deployment .
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
1- create a deployment .
1. Create a deployment

kubectl create deployment test-ekpose --image=nginx
deployment.apps/test-ekpose created
```
2- check if ing is created or no .
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
2- check if ing is created or no .
2. Check if the deployment has automatically been exposed, by listing the ingress resource

test-ekpose <none> * c04c862c-306f-48d0-84c0-54a80730d855.k8s.civo.com 80 44s
```

## Contributing
Copy link
Owner

Choose a reason for hiding this comment

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

I don't usually accept pull requests because people are going to follow this repo after watching the youtube video and they would be confused to see some changes here that are not covered in the videos. So, let's remove this section.


Please make sure to update tests as appropriate.

## License
Copy link
Owner

Choose a reason for hiding this comment

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

Can you please explain this a bit, why did we explicitly choose MIT? We can remove as well.

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

Successfully merging this pull request may close these issues.

2 participants