github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Removing old docs, setting latest false on docker

Browse Source
This commit is contained in:
Matt Bruzek 2015-04-20 17:00:41 -05:00
parent 7802db4862
commit a5da3708d2
5 changed files with 1 additions and 267 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cluster/juju/bundles/local.yaml
View File

@ -12,7 +12,7 @@ kubernetes-local:
charm: cs:trusty/docker
num_units: 2
options:
latest: true
latest: false
annotations:
"gui-x": "0"
"gui-y": "0"

81
cluster/juju/charms/trusty/kubernetes-master/docs/1-getting-started.md
View File

@ -1,81 +0,0 @@
# Getting Started
## Environment Considerations
Kubernetes has specific cloud provider integration, and as of the current writing of this document that supported list includes the official Juju supported providers:
- [Amazon AWS](https://jujucharms.com/docs/config-aws)
- [Azure](https://jujucharms.com/docs/config-azure)
- [Vagrant](https://jujucharms.com/docs/config-vagrant)
Other providers available for use as a *juju manual environment* can be listed in the [Kubernetes Documentation](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/docs/getting-started-guides)
## Deployment
The Kubernetes Charms are currently under heavy development. We encourage you to fork these charms and contribute back to the development effort! See our [contributing](contributing.md) doc for more information on this.
#### Deploying the Preview Release charms
juju deploy cs:~hazmat/trusty/etcd
juju deploy cs:~hazmat/trusty/flannel
juju deploy local:trusty/kubernetes-master
juju deploy local:trusty/kubernetes
juju add-relation etcd flannel
juju add-relation etcd kubernetes
juju add-relation etcd kubernetes-master
juju add-relation kubernetes kubernetes-master
#### Deploying the Development Release Charms
> These charms are known to be unstable as they are tracking the current efforts of the community at enabling different features against Kubernetes. This includes the specifics for integration per cloud environment, and upgrading to the latest development version.
mkdir -p ~/charms/trusty
git clone https://github.com/whitmo/kubernetes-master.git ~/charms/trusty/kubernetes-master
git clone https://github.com/whitmo/kubernetes.git ~/charms/trusty/kubernetes
##### Skipping the manual deployment after git clone
> **Note:** This path requires the pre-requisite of juju-deployer. You can obtain juju-deployer via `apt-get install juju-deployer`
wget https://github.com/whitmo/bundle-kubernetes/blob/master/develop.yaml kubernetes-devel.yaml
juju-deployer kubernetes-devel.yaml
## Verifying Deployment with the Kubernetes Agent
You'll need the kubernetes command line client to utlize the created cluster. And this can be fetched from the [Releases](https://github.com/GoogleCloudPlatform/kubernetes/releases) page on the Kubernetes project. Make sure you're fetching a client library that matches what the charm is deploying.
Grab the tarball and from the extracted release you can just directly use the cli binary at ./kubernetes/platforms/linux/amd64/kubecfg
You'll need the address of the kubernetes master as environment variable :
juju status kubernetes-master/0
Grab the public-address there and export it as KUBERNETES_MASTER environment variable :
export KUBERNETES_MASTER=$(juju status --format=oneline kubernetes-master | cut -d' ' -f3):8080
And now you can run through the kubernetes examples per normal. :
kubecfg list minions
## Scale Up
If the default capacity of the bundle doesn't provide enough capacity for your workload(s) you can scale horizontially by adding a unit to the flannel and kubernetes services respectively.
juju add-unit flannel
juju add-unit kubernetes --to # (machine id of new flannel unit)
## Known Issues / Limitations
Kubernetes currently has platform specific functionality. For example load balancers and persistence volumes only work with the google compute provider atm.
The Juju integration uses the kubernetes null provider. This means external load balancers and storage can't be directly driven through kubernetes config files.
## Where to get help
If you run into any issues, file a bug at our [issue tracker](http://github.com/whitmo/kubernetes-charm/issues), email the Juju Mailing List at <juju@lists.ubuntu.com>, or feel free to join us in #juju on irc.freenode.net.

52
cluster/juju/charms/trusty/kubernetes-master/docs/contributing.md
View File

@ -1,52 +0,0 @@
#### Contributions are welcome, in any form. Whether that be Bugs, BugFixes, Documentation, or Features.
### Submitting a bug
1. Go to our [issue tracker](http://github.com/whitmo/kubernetes-master-charm/issues) on GitHub
2. Search for existing issues using the search field at the top of the page
3. File a new issue including the info listed below
4. Thanks a ton for helping make the Kubernetes-Master Charm higher quality!
##### When filing a new bug, please include:
- **Descriptive title** - use keywords so others can find your bug (avoiding duplicates)
- **Steps to trigger the problem** - that are specific, and repeatable
- **What happens** - when you follow the steps, and what you expected to happen instead.
- Include the exact text of any error messages if applicable (or upload screenshots).
- Kubernetes-Master Charm version (or if you're pulling directly from Git, your current commit SHA - use git rev-parse HEAD) and the Juju Version output from `juju --version`.
- Did this work in a previous charm version? If so, also provide the version that it worked in.
- Any errors logged in `juju debug log` Console view
### Can I help fix a bug?
Yes please! But first...
- Make sure no one else is already working on it -- if the bug has a milestone assigned or is tagged 'fix in progress', then it's already under way. Otherwise, post a comment on the bug to let others know you're starting to work on it.
We use the Fork & Pull model for distributed development. For a more in-depth overview: consult with the github documentation on [Collaborative Development Models](https://help.github.com/articles/using-pull-requests/#before-you-begin).
> ##### Fork & pull
>
> The fork & pull model lets anyone fork an existing repository and push changes to their personal fork without requiring access be granted to the source repository. The changes must then be pulled into the source repository by the project maintainer. This model reduces the amount of friction for new contributors and is popular with open source projects because it allows people to work independently without upfront coordination.
### Submitting a Bug Fix
The following checklist will help developers not familiar with the fork and pull process of development. We appreciate your enthusiasm to make the Kubernetes-Master Charm a High Quality experience! To Rapidly get started - follow the 8 steps below.
1. [Fork the repository](https://help.github.com/articles/fork-a-repo/)
2. Clone your fork `git clone git@github.com/myusername/kubernetes-master-charm.git`
3. Checkout your topic branch with `git checkout -b my-awesome-bugfix`
4. Hack away at your feature/bugfix
5. Validate your bugfix if possible in the amulet test(s) so we dont reintroduce it later.
6. Validate your code meets guidelines by passing lint tests `make lint`
6. Commit code `git commit -a -m 'i did all this work to fix #32'`
7. Push your branch to your forks remote branch `git push origin my-awesome-bugfix`
8. Create the [Pull Request](https://help.github.com/articles/using-pull-requests/#initiating-the-pull-request)
9. Await Code Review
10. Rejoice when Pull Request is accepted
### Submitting a Feature
The Steps are the same as [Submitting a Bug Fix](#submitting-a-bug-fix). If you want extra credit, make sure you [File an issue](http://github.com/whitmo/kubernetes-master-charm/issues) that covers the Feature you are working on - as kind of a courtesy heads up. And assign the issue to yourself so we know you are working on it.

81
cluster/juju/charms/trusty/kubernetes/docs/1-getting-started.md
View File

@ -1,81 +0,0 @@
# Getting Started
## Environment Considerations
Kubernetes has specific cloud provider integration, and as of the current writing of this document that supported list includes the official Juju supported providers:
- [Amazon AWS](https://jujucharms.com/docs/config-aws)
- [Azure](https://jujucharms.com/docs/config-azure)
- [Vagrant](https://jujucharms.com/docs/config-vagrant)
Other providers available for use as a *juju manual environment* can be listed in the [Kubernetes Documentation](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/docs/getting-started-guides)
## Deployment
The Kubernetes Charms are currently under heavy development. We encourage you to fork these charms and contribute back to the development effort! See our [contributing](contributing.md) doc for more information on this.
#### Deploying the Preview Release charms
juju deploy cs:~hazmat/trusty/etcd
juju deploy cs:~hazmat/trusty/flannel
juju deploy local:trusty/kubernetes-master
juju deploy local:trusty/kubernetes
juju add-relation etcd flannel
juju add-relation etcd kubernetes
juju add-relation etcd kubernetes-master
juju add-relation kubernetes kubernetes-master
#### Deploying the Development Release Charms
> These charms are known to be unstable as they are tracking the current efforts of the community at enabling different features against Kubernetes. This includes the specifics for integration per cloud environment, and upgrading to the latest development version.
mkdir -p ~/charms/trusty
git clone https://github.com/whitmo/kubernetes-master.git ~/charms/trusty/kubernetes-master
git clone https://github.com/whitmo/kubernetes.git ~/charms/trusty/kubernetes
##### Skipping the manual deployment after git clone
> **Note:** This path requires the pre-requisite of juju-deployer. You can obtain juju-deployer via `apt-get install juju-deployer`
wget https://github.com/whitmo/bundle-kubernetes/blob/master/develop.yaml kubernetes-devel.yaml
juju-deployer kubernetes-devel.yaml
## Verifying Deployment with the Kubernetes Agent
You'll need the kubernetes command line client to utlize the created cluster. And this can be fetched from the [Releases](https://github.com/GoogleCloudPlatform/kubernetes/releases) page on the Kubernetes project. Make sure you're fetching a client library that matches what the charm is deploying.
Grab the tarball and from the extracted release you can just directly use the cli binary at ./kubernetes/platforms/linux/amd64/kubecfg
You'll need the address of the kubernetes master as environment variable :
juju status kubernetes-master/0
Grab the public-address there and export it as KUBERNETES_MASTER environment variable :
export KUBERNETES_MASTER=$(juju status --format=oneline kubernetes-master | cut -d' ' -f3):8080
And now you can run through the kubernetes examples per normal. :
kubecfg list minions
## Scale Up
If the default capacity of the bundle doesn't provide enough capacity for your workload(s) you can scale horizontially by adding a unit to the flannel and kubernetes services respectively.
juju add-unit flannel
juju add-unit kubernetes --to # (machine id of new flannel unit)
## Known Issues / Limitations
Kubernetes currently has platform specific functionality. For example load balancers and persistence volumes only work with the google compute provider atm.
The Juju integration uses the kubernetes null provider. This means external load balancers and storage can't be directly driven through kubernetes config files.
## Where to get help
If you run into any issues, file a bug at our [issue tracker](http://github.com/whitmo/kubernetes-charm/issues), email the Juju Mailing List at <juju@lists.ubuntu.com>, or feel free to join us in #juju on irc.freenode.net.

52
cluster/juju/charms/trusty/kubernetes/docs/contributing.md
View File

@ -1,52 +0,0 @@
#### Contributions are welcome, in any form. Whether that be Bugs, BugFixes, Documentation, or Features.
### Submitting a bug
1. Go to our [issue tracker](http://github.com/whitmo/kubernetes-charm/issues) on GitHub
2. Search for existing issues using the search field at the top of the page
3. File a new issue including the info listed below
4. Thanks a ton for helping make the Kubernetes Charm higher quality!
##### When filing a new bug, please include:
- **Descriptive title** - use keywords so others can find your bug (avoiding duplicates)
- **Steps to trigger the problem** - that are specific, and repeatable
- **What happens** - when you follow the steps, and what you expected to happen instead.
- Include the exact text of any error messages if applicable (or upload screenshots).
- Kubernetes Charm version (or if you're pulling directly from Git, your current commit SHA - use git rev-parse HEAD) and the Juju Version output from `juju --version`.
- Did this work in a previous charm version? If so, also provide the version that it worked in.
- Any errors logged in `juju debug log` Console view
### Can I help fix a bug?
Yes please! But first...
- Make sure no one else is already working on it -- if the bug has a milestone assigned or is tagged 'fix in progress', then it's already under way. Otherwise, post a comment on the bug to let others know you're starting to work on it.
We use the Fork & Pull model for distributed development. For a more in-depth overview: consult with the github documentation on [Collaborative Development Models](https://help.github.com/articles/using-pull-requests/#before-you-begin).
> ##### Fork & pull
>
> The fork & pull model lets anyone fork an existing repository and push changes to their personal fork without requiring access be granted to the source repository. The changes must then be pulled into the source repository by the project maintainer. This model reduces the amount of friction for new contributors and is popular with open source projects because it allows people to work independently without upfront coordination.
### Submitting a Bug Fix
The following checklist will help developers not familiar with the fork and pull process of development. We appreciate your enthusiasm to make the Kubernetes Charm a High Quality experience! To Rapidly get started - follow the 8 steps below.
1. [Fork the repository](https://help.github.com/articles/fork-a-repo/)
2. Clone your fork `git clone git@github.com/myusername/kubernetes-charm.git`
3. Checkout your topic branch with `git checkout -b my-awesome-bugfix`
4. Hack away at your feature/bugfix
5. Validate your bugfix if possible in the amulet test(s) so we dont reintroduce it later.
6. Validate your code meets guidelines by passing lint tests `make lint`
6. Commit code `git commit -a -m 'i did all this work to fix #32'`
7. Push your branch to your forks remote branch `git push origin my-awesome-bugfix`
8. Create the [Pull Request](https://help.github.com/articles/using-pull-requests/#initiating-the-pull-request)
9. Await Code Review
10. Rejoice when Pull Request is accepted
### Submitting a Feature
The Steps are the same as [Submitting a Bug Fix](#submitting-a-bug-fix). If you want extra credit, make sure you [File an issue](http://github.com/whitmo/kubernetes-charm/issues) that covers the Feature you are working on - as kind of a courtesy heads up. And assign the issue to yourself so we know you are working on it.