Skip to content
This repository has been archived by the owner on Nov 15, 2022. It is now read-only.

Add getting started guide #508

Merged
merged 1 commit into from
Dec 6, 2017

Conversation

cdrage
Copy link
Collaborator

@cdrage cdrage commented Dec 4, 2017

Adds a getting started guide on how to use minishift + kedge as well as
minikube + kedge.

In this guide, we'll deploy a sample kedge file `httpd.yaml` to a Kubernetes cluster.

Requirements:
- [minikube](https://github.com/kubernetes/minikube)
Copy link
Member

Choose a reason for hiding this comment

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

put the downlaod instructions link!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If people follow the link, they'll find the installation instructions :)


Requirements:
- [minikube](https://github.com/kubernetes/minikube)
- [kedge](https://github.com/kedgeproject/kedge)
Copy link
Member

Choose a reason for hiding this comment

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

put the downlaod instructions link!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If people follow the link, they'll find the installation instructions :)

__Download the [httpd.yaml](https://raw.githubusercontent.com/kedgeproject/kedge/master/examples/httpd/httpd.yaml) example file, or another example from the [examples](https://github.com/kedgeproject/kedge/tree/master/examples) GitHub directory:__

```sh
wget https://raw.githubusercontent.com/kedgeproject/kedge/master/examples/httpd/httpd.yaml
Copy link
Member

Choose a reason for hiding this comment

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

nit: wget is not installed in lot of machines by default, how about curl -O

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

You're right. Added!


__Deploy directly to your OpenShift cluster with `kedge apply`:__

Run `kedge apply -f backend.yaml -f frontend.yaml -f db.yaml` in the same directory as your example files.
Copy link
Member

Choose a reason for hiding this comment

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

If we have only kedge files in the directory then we can always do kedge apply -f ., . being the directory all files in that directory will be taken.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

IMO, I think we should keep the same.

Adds a getting started guide on how to use minishift + kedge as well as
minikube + kedge.
@cdrage cdrage force-pushed the add-getting-started-guide branch from 6266c8f to 064c509 Compare December 5, 2017 13:59
@cdrage
Copy link
Collaborator Author

cdrage commented Dec 6, 2017

I'm going to merge this in for-now so we have a guide for getting-started during Kubecon

@cdrage cdrage merged commit c5dd778 into kedgeproject:master Dec 6, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants