https://github.com/jeff1evesque/rancher-demonstration
Rancher 2.x demonstration
https://github.com/jeff1evesque/rancher-demonstration
docker kubernetes rancher-agent rancher-cli rancher-server
Last synced: 3 months ago
JSON representation
Rancher 2.x demonstration
- Host: GitHub
- URL: https://github.com/jeff1evesque/rancher-demonstration
- Owner: jeff1evesque
- Created: 2019-01-01T01:22:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-14T16:35:26.000Z (over 7 years ago)
- Last Synced: 2024-12-31T01:41:56.807Z (over 1 year ago)
- Topics: docker, kubernetes, rancher-agent, rancher-cli, rancher-server
- Language: Shell
- Homepage:
- Size: 57.6 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# rancher-demonstration
This repository is a simple demonstration of virtualized environments
([vagrant](https://www.vagrantup.com/) + [virtualbox](https://www.virtualbox.org/)),
tailored to exhibit the [kubernetes](https://kubernetes.io/)-based
[rancher-server](https://github.com/rancher/rancher), and [rancher-agent](https://github.com/rancher/agent) ecosystem.
Specifically, a [`Vagrantfile`](https://github.com/jeff1evesque/rancher-demonstration/blob/master/Vagrantfile) will automate the processes contained within
the provided [install scripts](https://github.com/jeff1evesque/rancher-demonstration/tree/master/utility).
In this setup, the [rancher-server](https://github.com/jeff1evesque/rancher-demonstration/blob/master/utility/install-rancher-server)
is launched using [Centos7x](https://github.com/jeff1evesque/rancher-demonstration/blob/1959f5817ca53d89c8d3349d3bb23406c3bf3ea6/Vagrantfile#L40-L46),
while the [rancher-agent](https://github.com/jeff1evesque/rancher-demonstration/blob/master/utility/install-rancher-agent)
is launched in [Bionic64](https://github.com/jeff1evesque/rancher-demonstration/blob/1959f5817ca53d89c8d3349d3bb23406c3bf3ea6/Vagrantfile#L47-L53).
If the rancher-server needs to be debian-based, or corresponding rancher-agents
need to be rhel-based, then additional utility scripts, not included in this
repository, will need to be created.
Regardless of implementation, when vagrant completes provisioning, a rancher-server,
is available via https://localhost:7895, and can be used to manage various
[kubernetes](https://kubernetes.io/)-based clusters:
---
Upon immediate login, the rancher-server may still be provisioning:
**Note:** the provided [install scripts](https://github.com/jeff1evesque/rancher-demonstration/tree/master/utility),
used to provision the corresponding vagrant virtual machine(s), can also be
used on production-like environments. However, for [high-availability](https://rancher.com/docs/rancher/v2.x/en/installation/ha/),
the [install-rancher-server](https://github.com/jeff1evesque/rancher-demonstration/blob/master/utility/install-rancher-server)
will need to be adjusted.
---
After a few minutes, the cluster will complete provisioning, and be active:
---
Then, the newly created cluster can be reviewed:
## Additional hosts
Additional hosts can be added to a desired cluster, by first clicking *Edit*
under the top-right hamburger icon:
At the bottom of the associated page, the corresponding docker command can be
pasted into the desired cluster host:
## Deployment
The `kubectl` command can be executed on the rancher-server via the web-browser,
or directly within the container:
```bash
[root@rancher-server vagrant]# docker ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
92dde0d45453 rancher/rancher:v2.1.5 "entrypoint.sh" 38 hours ago Up 38 hours 0.0.0.0:8890->80/tcp, 0.0 .0.0:8895->443/tcp rancher
[root@rancher-server vagrant]# docker exec -it rancher /bin/bash
root@92dde0d45453:/var/lib/rancher# kubectl run \
--image=nginx \
--port=80 \
--env='DOMAIN=cluster' \
replicas=3
```
**Note:** if `--env=` is passed, environment variables can be read from STDIN
using the standard env syntax.
Additionally, a yaml configuration file can be utilized:
```bash
[root@rancher-server vagrant]# docker ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
92dde0d45453 rancher/rancher:v2.1.5 "entrypoint.sh" 38 hours ago Up 38 hours 0.0.0.0:8890->80/tcp, 0.0 .0.0:8895->443/tcp rancher
[root@rancher-server vagrant]# docker exec -it rancher /bin/bash
root@92dde0d45453:/var/lib/rancher# kubectl create -f ./manifest.yaml
root@92dde0d45453:/var/lib/rancher# kubectl get deployments
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
nginx-deployment 3 3 3 3 18s
```
The following is an example `manifest.yaml`:
```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment
labels:
app: nginx
spec:
replicas: 3
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.7.9
ports:
- containerPort: 80
env:
- name: DOMAIN
value: cluster
```
**Note:** for development purposes, the `kind: Pod` can be implemented if
`replicas` are not needed. However, in production systems, the `kind: Deployment`
is typically desired.
**Note:** [Kompose](http://kompose.io/user-guide/) can convert an existing
`docker-compose.yml` to a series of kubernetes yaml files.
Alternatively, instead of defining multiple environment variables for each yaml
file, a custom [`configMapRef`](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#configure-all-key-value-pairs-in-a-configmap-as-container-environment-variables)
can be created:
```yaml
root@92dde0d45453:/var/lib/rancher# cat config/special_config.yml
apiVersion: v1
kind: ConfigMap
metadata:
name: special-config
namespace: default
data:
DOMAIN: cluster
root@92dde0d45453:/var/lib/rancher# kubectl create configmap special_config --from-file=config/special_config.yml
```
**Note:** the [ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/)
API resource stores configuration data as key-value pairs. The data can be
consumed in pods or provide the configurations for system components such as
controllers. ConfigMap is similar to [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/),
but provides a means of working with strings that don’t contain sensitive
information.
This allows the above `manifest.yaml` to refactor as follows:
```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment
labels:
app: nginx
spec:
replicas: 3
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.7.9
ports:
- containerPort: 80
envFrom:
- configMapRef:
name: special-config
key: DOMAIN
```
**Note:** if the `envFrom` > `key` is omitted, the entire `special-config`,
will be available within the given container.
## Configuration
Fork this project in your GitHub account. Then, clone your repository, with
one of the following approaches:
- [simple clone](https://jeff1evesque.github.io/machine-learning.docs/latest/html/configuration/setup-clone#simple-clone):
clone the remote master branch.
- [commit hash](https://jeff1evesque.github.io/machine-learning.docs/latest/html/configuration/setup-clone#commit-hash):
clone the remote master branch, then checkout a specific commit hash.
- [release tag](https://jeff1evesque.github.io/machine-learning.docs/latest/html/configuration/setup-clone#release-tag):
clone the remote branch, associated with the desired release tag.
## Installation
In order to proceed with the installation for this project, three dependencies
need to be installed:
- [Vagrant](https://www.vagrantup.com/)
- [Virtualbox x.y.z](http://download.virtualbox.org/virtualbox/5.1.2/) (or higher)
- [Extension Pack x.y.z](http://download.virtualbox.org/virtualbox/5.1.2/) (required)
Once the necessary dependencies have been installed, execute the following
command to build the rancher-server:
```bash
cd /path/to/rancher-demonstration/
vagrant up
```
**Note:** an alternative syntax to `vagrant up`, is to run `vagrant up rancher-server`.
However, the associated `rancher-agent` needs to be created as well.
Depending on the network speed, the build can take between 2-4 minutes. So,
grab a cup of coffee, and perhaps enjoy a danish while the virtual machine
builds.
**Note:** a more complete refresher on virtualization, can be found within the
vagrant [wiki page](https://github.com/jeff1evesque/machine-learning/wiki/Vagrant).
Though, the implemented [install scripts](https://github.com/jeff1evesque/rancher-demonstration/tree/master/utility)
can be used to provision vagrant, it can be run on non-vagrant systems. For example,
the [install scripts](https://github.com/jeff1evesque/rancher-demonstration/tree/master/utility)
can easily be run on corresponding virtual machines:
```bash
## virtual machine for rancher-server
./install-rancher-server \
"$server_version" \
"$server_internal_port" \
"$server_internal_https_port" \
>> "${project_root}/logs/install-rancher-server.txt" 2>&1
## virtual machine for rancher-agent
./install-rancher-agent \
"$agent_version" \
"$server_ip" \
"$server_internal_port" \
"$server_internal_https_port" \
>> "${project_root}/logs/install-rancher-agent.txt" 2>&1
```
**Note:** when running the above [install scripts](https://github.com/jeff1evesque/rancher-demonstration/tree/master/utility),
it is assumed that [docker](https://github.com/jeff1evesque/rancher-demonstration/blob/master/utility/install-docker),
and [rancher-cli](https://github.com/jeff1evesque/rancher-demonstration/blob/master/utility/install-rancher-cli)
dependencies have been accounted.