Skip to content

Commit

Permalink
Merge pull request k3s-io#149 from JakeConnors376W/patch-1
Browse files Browse the repository at this point in the history
Fix inconsistent title case
  • Loading branch information
ibuildthecloud authored Mar 5, 2019
2 parents 40b5914 + 2f84740 commit 36370fd
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ k3s is intended to be a fully compliant Kubernetes distribution with the followi
* CNI
* Host utilities (iptables, socat, etc)

Quick Start
Quick start
-----------
1. Download `k3s` from latest [release](https://github.com/rancher/k3s/releases/latest), x86_64, armhf, and arm64 are
supported
Expand All @@ -46,7 +46,7 @@ sudo k3s agent --server https://myserver:6443 --token ${NODE_TOKEN}

```

Running Server
Running server
--------------

To run the server just do
Expand Down Expand Up @@ -79,7 +79,7 @@ flag

At this point, you can run the agent as a separate process or not run it on this node at all.

Joining Nodes
Joining nodes
-------------

When the server starts it creates a file `/var/lib/rancher/k3s/server/node-token`. Use the contents
Expand Down Expand Up @@ -132,14 +132,14 @@ helper scripts

To build the full release binary run `make` and that will create `./dist/artifacts/k3s`

Kubernetes Source
Kubernetes source
-----------------

The source code for Kubernetes is in `vendor/` and the location from which that is copied
is in `./vendor.conf`. Go to the referenced repo/tag and you'll find all the patches applied
to upstream Kubernetes.

Open Ports/Network Security
Open ports / Network security
---------------------------

The server needs port 6443 to be accessible by the nodes. The nodes need to be able to reach
Expand Down Expand Up @@ -237,7 +237,7 @@ CoreDNS is deployed on start of the agent, to disable add `--no-deploy coredns`
If you don't install CoreDNS you will need to install a cluster DNS provider yourself.

Service Load Balancer
Service load balancer
---------------------

k3s includes a basic service load balancer that uses available host ports. If you try to create
Expand All @@ -255,4 +255,3 @@ Currently broken or stuff that needs to be done for this to be considered produc
2. HA
3. Work on e2e, sonobouy.
4. etcd doesn't actually work because args aren't exposed

0 comments on commit 36370fd

Please sign in to comment.