Commit 4a46ebc1 authored by moelsayed's avatar moelsayed
Browse files

Update readme

parent 024765a8
release/v1.3 1.2.5 enable_fossa githubaction-go-generate-2022-01-19-14-09-53 githubaction-go-generate-2022-01-19-16-59-09 githubaction-go-generate-2022-02-02-16-53-10 githubaction-go-generate-2022-03-19-01-55-24 githubaction-go-generate-2022-03-19-02-28-40 githubaction-go-generate-2022-03-24-18-41-17 githubaction-go-generate-2022-03-24-19-00-43 githubaction-go-generate-2022-04-27-01-07-30 githubaction-go-generate-2022-04-27-16-36-37 githubaction-go-generate-2022-04-28-23-21-04 githubaction-go-generate-2022-04-29-00-20-33 githubaction-go-generate-2022-04-29-03-20-39 githubaction-go-generate-2022-04-29-03-34-38 githubaction-go-generate-2022-05-05-16-15-24 githubaction-go-generate-2022-05-06-15-36-45 githubaction-go-generate-2022-05-06-21-32-47 kinarashah-patch-1 label-opened-issues master rancherbot_port_2796_release/v1.2_6efce927fbafb32468ad2dc45acb64511f4a6f31 release/bff7e0a release/v0.1 release/v0.2 release/v0.3 release/v1.0 release/v1.1 release/v1.1.10 release/v1.1.13 release/v1.1.2 release/v1.2 release/v1.2.1 revert-2326-rotate-encryption-keys revert-2374-revert-2326-rotate-encryption-keys revert-2541-no_selinux_relabel v0.1 v1.0 wg-10699 v1.3.11-rc2 v1.3.11-rc1 v1.3.10 v1.3.10-rc7 v1.3.10-rc6 v1.3.10-rc5 v1.3.10-rc4 v1.3.10-rc3 v1.3.10-rc2 v1.3.10-rc1 v1.3.9 v1.3.9-rc1 v1.3.8 v1.3.8-rc12 v1.3.8-rc11 v1.3.8-rc10 v1.3.8-rc9 v1.3.8-rc8 v1.3.8-rc7 v1.3.8-rc6 v1.3.8-rc5 v1.3.8-rc4 v1.3.8-rc3 v1.3.8-rc2 v1.3.8-rc1 v1.3.7 v1.3.7-rc1 v1.3.6 v1.3.6-rc1 v1.3.5 v1.3.5-rc1 v1.3.5-alpha1 v1.3.4 v1.3.4-rc1 v1.3.3 v1.3.3-rc6 v1.3.3-rc5 v1.3.3-rc4 v1.3.3-rc3 v1.3.3-rc2 v1.3.3-rc1 v1.3.2 v1.3.2-rc2 v1.3.2-rc1 v1.3.1 v1.3.1-rc1 v1.3.0 v1.3.0-rc20 v1.3.0-rc19 v1.3.0-rc18 v1.3.0-rc17 v1.3.0-rc16 v1.3.0-rc15 v1.3.0-rc14 v1.3.0-rc13 v1.3.0-rc12 v1.3.0-rc11 v1.3.0-rc10 v1.3.0-rc9 v1.3.0-rc8 v1.3.0-rc7 v1.3.0-rc6 v1.3.0-rc5 v1.3.0-rc4 v1.3.0-rc3 v1.3.0-rc2 v1.3.0-rc1 v1.2.20 v1.2.20-rc1 v1.2.19 v1.2.19-rc4 v1.2.19-rc3 v1.2.19-rc2 v1.2.19-rc1 v1.2.18 v1.2.18-rc1 v1.2.17 v1.2.17-rc1 v1.2.16 v1.2.16-rc1 v1.2.15 v1.2.15-rc1 v1.2.14 v1.2.14-rc2 v1.2.14-rc1 v1.2.13 v1.2.13-rc2 v1.2.13-rc1 v1.2.12 v1.2.12-rc1 v1.2.11 v1.2.11-rc0 v1.2.10 v1.2.10-rc0 v1.2.9 v1.2.9-rc2 v1.2.9-rc1 v1.2.8 v1.2.8-rc4 v1.2.8-rc3 v1.2.8-rc2 v1.2.8-rc1 v1.2.7 v1.2.7-rc1 v1.2.6 v1.2.6-rc6 v1.2.6-rc5 v1.2.6-rc4 v1.2.6-rc3 v1.2.6-rc2 v1.2.6-rc1 v1.2.5 v1.2.5-rc2 v1.2.5-rc1 v1.2.4 v1.2.4-rc9 v1.2.4-rc8 v1.2.4-rc7 v1.2.4-rc6 v1.2.4-rc5 v1.2.4-rc4 v1.2.4-rc3 v1.2.4-rc2 v1.2.4-rc1 v1.2.3 v1.2.3-rc1 v1.2.2 v1.2.2-rc6 v1.2.2-rc5 v1.2.2-rc4 v1.2.2-rc3 v1.2.2-rc2 v1.2.2-rc1 v1.2.1 v1.2.1-rc1 v1.2.0 v1.2.0-rc17 v1.2.0-rc16 v1.2.0-rc15 v1.2.0-rc14 v1.2.0-rc13 v1.2.0-rc12 v1.2.0-rc11 v1.2.0-rc10 v1.2.0-rc9 v1.2.0-rc8 v1.2.0-rc7 v1.2.0-rc6 v1.2.0-rc5 v1.2.0-rc4 v1.2.0-rc3 v1.2.0-rc2 v1.2.0-rc1 v1.1.19 v1.1.19-rc1 v1.1.18 v1.1.18-rc2 v1.1.18-rc1 v1.1.17 v1.1.17-rc2 v1.1.17-rc1 v1.1.16 v1.1.16-rc1 v1.1.15 v1.1.15-rc4 v1.1.15-rc3 v1.1.15-rc2 v1.1.15-rc1 v1.1.14 v1.1.14-rc3 v1.1.14-rc2 v1.1.14-rc1 v1.1.13 v1.1.13-rc3 v1.1.13-rc2 v1.1.13-rc1 v1.1.12 v1.1.12-rc1 v1.1.11 v1.1.11-rc6 v1.1.11-rc5 v1.1.11-rc4 v1.1.11-rc3 v1.1.11-rc2 v1.1.11-rc1 v1.1.10 v1.1.10-rc1 v1.1.9 v1.1.9-rc3 v1.1.9-rc2 v1.1.9-rc1 v1.1.8-rc1 v1.1.7 v1.1.6 v1.1.5 v1.1.5-rc9 v1.1.5-rc8 v1.1.5-rc7 v1.1.5-rc6 v1.1.5-rc5 v1.1.5-rc4 v1.1.5-rc3 v1.1.5-rc2 v1.1.5-rc1 v1.1.4 v1.1.4-rc2 v1.1.4-rc1 v1.1.3 v1.1.3-rc6 v1.1.3-rc5 v1.1.3-rc4 v1.1.3-rc3 v1.1.3-rc2 v1.1.3-rc1 v1.1.2 v1.1.2-rc4 v1.1.2-rc3 v1.1.2-rc1 v1.1.1 v1.1.1-rc1 v1.1.0 v1.1.0-rc19 v1.1.0-rc18 v1.1.0-rc17 v1.1.0-rc16 v1.1.0-rc15 v1.1.0-rc14 v1.1.0-rc13 v1.1.0-rc12 v1.1.0-rc11 v1.1.0-rc10 v1.1.0-rc9 v1.1.0-rc8 v1.1.0-rc7 v1.1.0-rc6 v1.1.0-rc5 v1.1.0-rc4 v1.1.0-rc3 v1.1.0-rc2 v1.1.0-rc1 v1.0.16 v1.0.16-rc1 v1.0.15 v1.0.15-rc2 v1.0.15-rc1 v1.0.14 v1.0.14-rc2 v1.0.14-rc1 v1.0.13 v1.0.13-rc1 v1.0.12 v1.0.12-rc1 v1.0.11 v1.0.11-rc1 v1.0.10 v1.0.10-rc1 v1.0.9 v1.0.9-rc2 v1.0.9-rc1 v1.0.8 v1.0.7 v1.0.7-rc3 v1.0.7-rc2 v1.0.7-rc1 v1.0.6 v1.0.6-rc4 v1.0.6-rc3 v1.0.6-rc2 v1.0.6-rc1 v1.0.5 v1.0.5-rc1 v1.0.4 v1.0.3 v1.0.2 v1.0.1 v1.0.1-rc5 v1.0.1-rc4 v1.0.1-rc3 v1.0.1-rc2 v1.0.1-rc1 v1.0.0 v1.0.0-rc6 v1.0.0-rc5 v1.0.0-rc4 v1.0.0-rc3 v1.0.0-rc2 v1.0.0-rc1 v0.3.2 v0.3.2-rc3 v0.3.2-rc2 v0.3.2-rc1 v0.3.1 v0.3.1-rc3 v0.3.1-rc2 v0.3.1-rc1 v0.3.0 v0.3.0-rc12 v0.3.0-rc11 v0.3.0-rc10 v0.3.0-rc9 v0.3.0-rc8 v0.3.0-rc7 v0.3.0-rc6 v0.3.0-rc5 v0.3.0-rc4 v0.3.0-rc3 v0.3.0-rc2 v0.3.0-rc1 v0.2.11 v0.2.11-rc4 v0.2.11-rc3 v0.2.11-rc2 v0.2.11-rc1 v0.2.10 v0.2.9 v0.2.9-rc2 v0.2.9-rc1 v0.2.8 v0.2.7 v0.2.7-rc2 v0.2.7-rc1 v0.2.6 v0.2.6-rc1 v0.2.5 v0.2.5-rc3 v0.2.5-rc2 v0.2.5-rc1 v0.2.4 v0.2.4-rc1 v0.2.3 v0.2.3-rc6 v0.2.3-rc5 v0.2.3-rc4 v0.2.3-rc3 v0.2.3-rc2 v0.2.3-rc1 v0.2.2 v0.2.2-rc1 v0.2.1 v0.2.1-rc3 v0.2.1-rc2 v0.2.1-rc1 v0.2.0 v0.2.0-rc13 v0.2.0-rc12 v0.2.0-rc11 v0.2.0-rc10 v0.2.0-rc9 v0.2.0-rc8 v0.2.0-rc7 v0.2.0-rc6 v0.2.0-rc5 v0.2.0-rc4 v0.2.0-rc3 v0.2.0-rc2 v0.2.0-rc1 v0.1.20 v0.1.19 v0.1.18 v0.1.17 v0.1.17-rc4 v0.1.17-rc3 v0.1.17-rc2 v0.1.17-rc1 v0.1.16 v0.1.16-rc2 v0.1.16-rc1 v0.1.15 v0.1.15-rc2 v0.1.15-rc1 v0.1.14 v0.1.14-rc1 v0.1.13 v0.1.13-rc1 v0.1.12 v0.1.12-rc5 v0.1.12-rc4 v0.1.12-rc3 v0.1.12-rc2 v0.1.12-rc1 v0.1.11 v0.1.11-rc1 v0.1.10 v0.1.10-rc5 v0.1.10-rc4 v0.1.10-rc3 v0.1.10-rc2 v0.1.10-rc1 v0.1.9 v0.1.9-rc10 v0.1.9-rc9 v0.1.9-rc8 v0.1.9-rc7 v0.1.9-rc6 v0.1.9-rc5 v0.1.9-rc4 v0.1.9-rc3 v0.1.9-rc2 v0.1.9-rc1 v0.1.8 v0.1.8-rc12 v0.1.8-rc11 v0.1.8-rc10 v0.1.8-rc9 v0.1.8-rc8 v0.1.8-rc7 v0.1.8-rc6 v0.1.8-rc5 v0.1.8-rc4 v0.1.8-rc3 v0.1.8-rc2 v0.1.8-rc1 v0.1.7 v0.1.7-rc6 v0.1.7-rc5 v0.1.7-rc4 v0.1.7-rc3 v0.1.7-rc2 v0.1.7-rc1 v0.1.6 v0.1.6-rc3 v0.1.6-rc2 v0.1.6-rc1 v0.1.5 v0.1.5-rc3 v0.1.5-rc2
No related merge requests found
Showing with 98 additions and 19 deletions
+98 -19
......@@ -38,24 +38,13 @@ You can view full sample of cluster.yml [here](https://github.com/rancher/rke/bl
### Minimal `cluster.yml` example
```yaml
# default k8s version: v1.8.9-rancher1-1
# default network plugin: flannel
nodes:
- address: 1.1.1.1
- address: 1.2.3.4
user: ubuntu
role: [controlplane,worker,etcd]
services:
etcd:
image: quay.io/coreos/etcd:latest
kube-api:
image: rancher/k8s:v1.8.3-rancher2
kube-controller:
image: rancher/k8s:v1.8.3-rancher2
scheduler:
image: rancher/k8s:v1.8.3-rancher2
kubelet:
image: rancher/k8s:v1.8.3-rancher2
kubeproxy:
image: rancher/k8s:v1.8.3-rancher2
```
## Network Plugins
......@@ -105,7 +94,7 @@ There are extra options that can be specified for each network plugin:
## Addons
RKE support pluggable addons on cluster bootstrap, user can specify the addon yaml in the cluster.yml file, and when running
RKE supports pluggable addons on cluster bootstrap, user can specify the addon yaml in the cluster.yml file, and when running
```yaml
rke up --config cluster.yml
......@@ -152,13 +141,13 @@ to start an HA cluster, just specify more than one host with role `controlplane`
## Adding/Removing Nodes
RKE support adding/removing nodes for worker and controlplane hosts, in order to add additional nodes you will only need to update the `cluster.yml` file with additional nodes and run `rke up` with the same file.
RKE supports adding/removing nodes for worker and controlplane hosts, in order to add additional nodes you will only need to update the `cluster.yml` file with additional nodes and run `rke up` with the same file.
To remove nodes just remove them from the hosts list in the cluster configuration file `cluster.yml`, and re run `rke up` command.
## Cluster Remove
RKE support `rke remove` command, the command does the following:
RKE supports `rke remove` command, the command does the following:
- Connect to each host and remove the kubernetes services deployed on it.
- Clean each host from the directories left by the services:
......@@ -172,7 +161,7 @@ Note that this command is irreversible and will destroy the kubernetes cluster e
## Cluster Upgrade
RKE support kubernetes cluster upgrade through changing the image version of services, in order to do that change the image option for each services, for example:
RKE supports kubernetes cluster upgrade through changing the image version of services, in order to do that change the image option for each services, for example:
```yaml
image: rancher/k8s:v1.8.2-rancher1
......@@ -196,7 +185,7 @@ RKE will first look for the local `kube_config_cluster.yml` and then tries to up
## RKE Config
RKE support command `rke config` which generates a cluster config template for the user, to start using this command just write:
RKE supports command `rke config` which generates a cluster config template for the user, to start using this command just write:
```bash
rke config --name mycluster.yml
......@@ -339,6 +328,12 @@ nodes:
- worker
```
## Deploying Rancher 2.0 using rke
Using RKE's pluggable user addons, it's possible to deploy Rancher 2.0 server with a single command using the [rancher-minimal.yml](https://github.com/rancher/rke/blob/master/rancher-minimal.yml) cluster configuration:
```bash
rke up --config rancher-minimal.yml
```
## Operating Systems Notes
### Atomic OS
......
# default k8s version: v1.8.9-rancher1-1
# default network plugin: flannel
nodes:
- address: 1.2.3.4
user: ubuntu
role: [controlplane,etcd,worker]
addons: |-
---
kind: Namespace
apiVersion: v1
metadata:
name: cattle-system
---
kind: ClusterRoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
name: cattle-crb
subjects:
- kind: User
name: system:serviceaccount:cattle-system:default
apiGroup: rbac.authorization.k8s.io
roleRef:
kind: ClusterRole
name: cluster-admin
apiGroup: rbac.authorization.k8s.io
---
apiVersion: v1
kind: Service
metadata:
namespace: cattle-system
name: cattle-service
labels:
app: cattle
spec:
ports:
- port: 80
targetPort: 80
protocol: TCP
name: http
- port: 443
targetPort: 443
protocol: TCP
name: https
selector:
app: cattle
---
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
namespace: cattle-system
name: cattle-ingress-http
spec:
rules:
- http:
paths:
- backend:
serviceName: cattle-service
servicePort: 80
- backend:
serviceName: cattle-service
servicePort: 443
---
kind: Deployment
apiVersion: extensions/v1beta1
metadata:
namespace: cattle-system
name: cattle
spec:
replicas: 1
template:
metadata:
labels:
app: cattle
spec:
containers:
- image: rancher/server:master
imagePullPolicy: Always
name: cattle-server
ports:
- containerPort: 80
protocol: TCP
- containerPort: 443
protocol: TCP
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment