Page History

Info
Steps described in this page are run by "ubuntu", a non-root user.

ONAP deployment in Kubernetes is modeled in the oom project as a one-to-one set of service to pod sets (one pod per docker container).

...

#

Purpose

Command and Example

1

Add host name to /etc/hosts file

^note-1

sudo vi /etc/hosts

Expand

title	Example result of /etc/hosts file

ubuntu@sdnc-k8s:~$ $ more /etc/hosts

127.0.0.1 sdnc-k8s localhost

...

10.147.132.10 sdnc-k8s

10.147.90.6 sdnc-k8s-2

2

Clone the OOM project from ONAP gerrit

git clone http://gerrit.onap.org/r/oom

3

Install Docker 1.12

^note-2

curl https://releases.rancher.com/install-docker/1.12.sh | sh

Expand

title	Example of docker installation

+ sudo -E sh -c docker version

Client:

Version:

$ curl https://releases.rancher.com/install-docker/1.12.

6

API version: 1.24

Go version: go1.6.4

Git commit: 78d1802

Built: Tue Jan 10 20:38:45 2017

OS/Arch: linux/amd64

Server:

Version: 1.12.6

API version: 1.24

Go version:

sh | sh
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 16609 100 16609 0 0 18977 0 --:--:-- --:--:-- --:--:-- 18960
apparmor is enabled in the kernel and apparmor utils were already installed
+ sudo -E sh -c sleep 3; apt-get update

...

+ sudo -E sh -c docker version
Client:
Version: 1.12.6
API version: 1.24
Go version: go1.6.4

Git

Git commit:

78d1802

Built

Built:

Tue Jan 10 20:38:45 2017

OS

OS/Arch:

linux/amd64

If you would like to use Docker as a non-root user, you should now consider

adding your user to the "docker" group with something like:

sudo usermod -aG docker ubuntu

Remember that you will have to log out and back in for this to take effect!

4

Install/Start Rancher server ³

Only on master node (if you are installing more than one Kubernetes nodes), Use port 8880 instead of 8080.

docker run -d --restart=unless-stopped -p 8880:8080 rancher/server:v1.6.10

Expand

title	Example of rancher start in docker

Unable to find image 'rancher/server:latest' locally

latest: Pulling from rancher/server

6599cadaf950: Pull complete

23eda618d451: Pull complete

f0be3084efe9: Pull complete

52de432f084b: Pull complete

a3ed95caeb02: Pull complete

e75cd91a1dc5: Pull complete

997f1b48f59f: Pull complete

313c28fb4e37: Pull complete

2a0730d1275c: Pull complete

8848fbebd2c8: Pull complete

906504ea9ea6: Pull complete

9329940f8e65: Pull complete

e849debd7945: Pull complete

4883bd135dd2: Pull complete

605c6a0fe940: Pull complete

274bc004c933: Pull complete

a6cb25e8d1a2: Pull complete

3ded9d4c8c2b: Pull complete

a571d2f40012: Pull complete

Digest: sha256:096026aa3eed411077690c904cd5dd3cce66eb39312c78a84209eab23387c36d

Status: Downloaded newer image for rancher/server:latest

4b3020cfccc2db47905e89e66cd8533fea82d60b886b2f4509e5f1c56764563a

Expand

title	Example of validate rancher server is up in docker

ubuntu@sdnc-k8s:~$ docker ps

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES

4b3020cfccc2 rancher/server "/usr/bin/entry /usr/" 12 minutes ago Up 12 minutes 3306/tcp, 0.0.0.0:8880->8080/tcp backstabbing_wright

Notes:

Adding all cluster nodes to /etc/hosts file on each node is optional
Check out compartible versions among Rancher, Kubernetes and Docker
There may be issues with the DNS pod in Rancher after a reboot or when running clustered hosts as described in ONAP bug OOM-236 (Rancher DNS pod non-functional after system reboot - only in cluster mode). A clean system is OK.

Configure Rancher Client

You can access the Rancher UI through http:<master host IP>:8880 ; it takes you to the apps/stacks page.

For example,

You can access Rancher from http://10.147.132.10:8880/; the page will be opened to http://10.147.132.10:8880/env/1a5/apps/stacks.

From here, follow the steps below to configure the Rancher:

Server:
Version: 1.12.6
API version: 1.24
Go version: go1.6.4
Git commit: 78d1802
Built: Tue Jan 10 20:38:45 2017
OS/Arch: linux/amd64

If you would like to use Docker as a non-root user, you should now consider
adding your user to the "docker" group with something like:

sudo usermod -aG docker ubuntu

Remember that you will have to log out and back in for this to take effect!

$

sudo usermod -aG docker ubuntu

logout

log back in and validate docker command is usable

Expand

title	An example of validating docker command is usable

$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES

$

4

Install/Start Rancher server

^note-3

Only on one node (if you are installing more than one Kubernetes nodes, choose one node to run the Rancher). Use port 8880 instead of 8080.

docker run -d --restart=unless-stopped -p 8880:8080 rancher/server:v1.6.10

Expand

title	Example of rancher start in docker

$ docker run -d --restart=unless-stopped -p 8880:8080 rancher/server:v1.6.10

Unable to find image 'rancher/server:latest' locally

latest: Pulling from rancher/server

6599cadaf950: Pull complete

23eda618d451: Pull complete

f0be3084efe9: Pull complete

52de432f084b: Pull complete

a3ed95caeb02: Pull complete

e75cd91a1dc5: Pull complete

997f1b48f59f: Pull complete

313c28fb4e37: Pull complete

2a0730d1275c: Pull complete

8848fbebd2c8: Pull complete

906504ea9ea6: Pull complete

9329940f8e65: Pull complete

e849debd7945: Pull complete

4883bd135dd2: Pull complete

605c6a0fe940: Pull complete

274bc004c933: Pull complete

a6cb25e8d1a2: Pull complete

3ded9d4c8c2b: Pull complete

a571d2f40012: Pull complete

Digest: sha256:096026aa3eed411077690c904cd5dd3cce66eb39312c78a84209eab23387c36d

Status: Downloaded newer image for rancher/server:latest

4b3020cfccc2db47905e89e66cd8533fea82d60b886b2f4509e5f1c56764563a

Expand

title	Example of validate rancher server is up in docker

$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
e3f1c2ce3234 rancher/server:v1.6.10 "/usr/bin/entry /usr/" 7 seconds ago Up 6 seconds 3306/tcp, 0.0.0.0:8880->8080/tcp pensive_goldberg
$

$ docker ps

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES

4b3020cfccc2 rancher/server "/usr/bin/entry /usr/" 12 minutes ago Up 12 minutes 3306/tcp, 0.0.0.0:8880->8080/tcp backstabbing_wright

Notes:

Adding all cluster nodes to /etc/hosts file on each node is optional
Check out compartible versions among Rancher, Kubernetes and Docker
There may be issues with the DNS pod in Rancher after a reboot or when running clustered hosts as described in ONAP bug OOM-236 (Rancher DNS pod non-functional after system reboot - only in cluster mode). A clean system is OK.

Configure Rancher Client

You can access the Rancher UI through http:<master host IP>:8880 ; it takes you to the apps/stacks page.

For example,

You can access Rancher from http://10.147.132.10:8880/; the page will be opened to http://10.147.132.10:8880/env/1a5/apps/stacks.

From here, follow the steps below to configure the Rancher:

#

Purpose

Script shots illustrated steps

1

Create Rancher environment:

Launch "Manage Enviroments" page
Image Added

Click on "Add Enviroment"
Image Added
Fill in the template with the following, and then click on the Create button
- Name: "sdnc-ha"
- (Optional) Add Description of the new environment
- Environment Template: Kubernetes
Image Added

Check that the new enviroment has been created and displays as "Active" Image Added

Expand

title	Delete pre-existing Default environment

Image Added

2

Add host to INFRASTRUCTURE

Go to the Hosts page via INFRASTRUCTURE -> Hosts
Click on the AddHost button

Image Added

For the first time only, the following confirmation page will appear (click the Save button to continue):

Image Added

The following Add Host page will appear:

Image Added

Skip steps 1, 2, and 3 listed in the page
In step 4, fill in the blank with the server IP

In step 5:

Click the Copy to Clipboard button to copy the command and run it on the server

Expand

title	Example of registering rancher agent on the server

$ docker run -e CATTLE_AGENT_IP="10.147.132.10" --rm --privileged -v /var/run/docker.sock:/var/run/docker.sock -v /var/lib/rancher:/var/lib/rancher rancher/agent:v1.2.6http://10.147.132.10:8880/v1/scripts/774E9A523D82DBCBDE13:1483142400000:FPPmrMz8IurKQwVLV2UpfGR10AY

Unable to find image 'rancher/agent:v1.2.6' locally

v1.2.6: Pulling from rancher/agent

b3e1c725a85f: Pull complete

6a710864a9fc: Pull complete

d0ac3b234321: Pull complete

87f567b5cf58: Pull complete

063e24b217c4: Pull complete

d0a3f58caef0: Pull complete

16914729cfd3: Pull complete

2ce3828c0b9d: Pull complete

7df47a98fc4b: Pull complete

Digest: sha256:a68afd351c7417e6d66a77e97144113ceb7a9c3cdd46fb6e1fd5f5a5a33111cd

Status: Downloaded newer image for rancher/agent:v1.2.6

INFO: Running Agent Registration Process, CATTLE_URL=http://10.147.132.10:8880/v1

INFO: Attempting to connect to: http://10.147.132.10:8880/v1

INFO: http://10.147.132.10:8880/v1 is accessible

INFO: Inspecting host capabilities

INFO: Boot2Docker: false

INFO: Host writable: true

INFO: Token: xxxxxxxx

INFO: Running registration

INFO: Printing Environment

INFO: ENV: CATTLE_ACCESS_KEY=0CB90B4247A136F6E43E

INFO: ENV: CATTLE_AGENT_IP=10.147.132.10

INFO: ENV: CATTLE_HOME=/var/lib/cattle

INFO: ENV: CATTLE_REGISTRATION_ACCESS_KEY=registrationToken

INFO: ENV: CATTLE_REGISTRATION_SECRET_KEY=xxxxxxx

INFO: ENV: CATTLE_SECRET_KEY=xxxxxxx

INFO: ENV: CATTLE_URL=http://10.147.132.10:8880/v1

INFO: ENV: DETECTED_CATTLE_AGENT_IP=172.17.0.1

INFO: ENV: RANCHER_AGENT_IMAGE=rancher/agent:v1.2.6

INFO: Launched Rancher Agent: 4e3b1e4c2b4c33095ef550cbece626277b63783b012efe74ed2713df63cc925c

Expand

title	Example of validating rancher agent started

$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
64562118a30c rancher/etcd:v2.3.7-13 "/.r/r /opt/rancher/r" 1 seconds ago Up Less than a second r-kubernetes-etcd-1-b95cd471
308b3fbf1882 rancher/net:holder "/.r/r /rancher-entry" 12 seconds ago Up 11 seconds r-ipsec-ipsec-1-9198fa8b
523278d910f4 rancher/dns:v0.15.3 "/rancher-entrypoint." 12 seconds ago Up 11 seconds r-network-services-metadata-dns-1-2730cb6f
8520cc50c5ff rancher/metadata:v0.9.4 "/rancher-entrypoint." 13 seconds ago Up 12 seconds r-network-services-metadata-1-53bf4aaf
1f6dcb021f5b rancher/healthcheck:v0.3.3 "/.r/r /rancher-entry" 14 seconds ago Up 13 seconds r-healthcheck-healthcheck-1-3d14df58
1d7ad141ceec rancher/network-manager:v0.7.8 "/rancher-entrypoint." 14 seconds ago Up 13 seconds r-network-services-network-manager-1-fdd38b68
c7dfdde262d7 rancher/net:v0.11.9 "/rancher-entrypoint." 14 seconds ago Up 13 seconds

#

Purpose

Script shots illustrated steps

1

Create Rancher environment:

Launch "Manage enviroments" page

Image Removed

Name: "sdnc-ha"
(Optional) Add Description of the new environment
Environment Template: Kubernetes
Click on the Create button

Image Removed

Check that the new enviroment has been created and displays as "Active"

Image Removed

Expand

title	(Optional) delete pre-existing Default environment

Image Removed

2

Add host to INFRASTRUCTURE

Go to the Hosts page via INFRASTRUCTURE -> Hosts
Click on the AddHost button

Image Removed

For the first time only, the following confirmation page will appear (click the Save button to continue):

Image Removed

The following Add Host page will appear:

Image Removed

Skip steps 1, 2, and 3
In step 4, fill in the blank with the server IP

In step 5:

Click the Copy to Clipboard button to copy the command and run it on the server

Expand

title	Example of registering rancher agent on the server

ubuntu@sdnc-k8s:~$ docker run -e CATTLE_AGENT_IP="10.147.132.10" --rm --privileged -v /var/run/docker.sock:/var/run/docker.sock -v /var/lib/rancher:/var/lib/rancher rancher/agent:v1.2.6http://10.147.132.10:8880/v1/scripts/774E9A523D82DBCBDE13:1483142400000:FPPmrMz8IurKQwVLV2UpfGR10AY

Unable to find image 'rancher/agent:v1.2.6' locally

v1.2.6: Pulling from rancher/agent

b3e1c725a85f: Pull complete

6a710864a9fc: Pull complete

d0ac3b234321: Pull complete

87f567b5cf58: Pull complete

063e24b217c4: Pull complete

d0a3f58caef0: Pull complete

16914729cfd3: Pull complete

2ce3828c0b9d: Pull complete

7df47a98fc4b: Pull complete

Digest: sha256:a68afd351c7417e6d66a77e97144113ceb7a9c3cdd46fb6e1fd5f5a5a33111cd

Status: Downloaded newer image for rancher/agent:v1.2.6

INFO: Running Agent Registration Process, CATTLE_URL=http://10.147.132.10:8880/v1

INFO: Attempting to connect to: http://10.147.132.10:8880/v1

INFO: http://10.147.132.10:8880/v1 is accessible

INFO: Inspecting host capabilities

INFO: Boot2Docker: false

INFO: Host writable: true

INFO: Token: xxxxxxxx

INFO: Running registration

INFO: Printing Environment

INFO: ENV: CATTLE_ACCESS_KEY=0CB90B4247A136F6E43E

INFO: ENV: CATTLE_AGENT_IP=10.147.132.10

INFO: ENV: CATTLE_HOME=/var/lib/cattle

INFO: ENV: CATTLE_REGISTRATION_ACCESS_KEY=registrationToken

INFO: ENV: CATTLE_REGISTRATION_SECRET_KEY=xxxxxxx

INFO: ENV: CATTLE_SECRET_KEY=xxxxxxx

INFO: ENV: CATTLE_URL=http://10.147.132.10:8880/v1

INFO: ENV: DETECTED_CATTLE_AGENT_IP=172.17.0.1

INFO: ENV: RANCHER_AGENT_IMAGE=rancher/agent:v1.2.6

INFO: Launched Rancher Agent: 4e3b1e4c2b4c33095ef550cbece626277b63783b012efe74ed2713df63cc925c

Expand

title	Example of validating rancher agent started

ubuntu@sdnc-k8s:~$ docker ps

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES

43eff054da6a        rancher/net:v0.11.9    "/rancher-entrypoint."   5 seconds ago       Up 4 seconds                                            r-ipsec-cni-driver-1-4a5c6e16415b67fe
4e3b1e4c2b4c        64e2f05b0394 rancher/agent:v1.2.6   6 "/run.sh run"             27 20 seconds ago      Up 27 seconds                                           ago Up 19 seconds rancher-agent
4b3020cfccc2       e3f1c2ce3234 rancher/server        server:v1.6.10 "/usr/bin/entry /usr/"    46 9 minutes ago      ago Up 46 minutes       9 minutes 3306/tcp, 0.0.0.0:8880->8080/tcp   backstabbing_wrighttcp pensive_goldberg
$

Click on the Close button to close the Add Host page

Go to the Hosts page from INFRASTRUCTURE -> Hosts
- You should see the newly added host:
  Expand
  title Example of Hosts page with one node
  Expand
  title Example of Hosts page has 2 nodes

3

Confirm that the host process has completed

The end of adding the host operation is indicated by the CLI option shown under the KUBERNETES dropdown menu:

Expand

title	Example of CLI option in KUBERNETES drop down

...

#

Purpose

Command and Example

1

Download kubectl on the server

curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl

Expand

title	Example of download kubectl process

% Total % Received % Xferd Average Speed Time Time Time Current

Dload Upload Total Spent Left Speed

100 49.8M 100 49.8M 0 0 15.3M 0 0:00:03 0:00:03 --:--:-- 15.3M

2

Enable the kubectl command

chmod +x ./ kubectl

sudo mv ./ kubectl /usr/local/bin/kubectl

3

Generate Config from the Rancher UI

From the Rancher UI, go to a Kubernetes CLI page through KUBERNETES -> CLI
Click on the Generate Config button to generate the config

The following content will be brought up; click on the Copy to Clipboard button to copy the generated config and use it in next step:

4

Create the kube config on the server

mkdir ~/.kube

vi ~/.kube/config

Paste the generated config from rancher UI (from last step) to this file, then save the file.

5

Validate the kube config

kubectl cluster-info

Expand

title	Example of validation result on kube config through "kubectl cluster-info"

$ kubectl cluster-info

Kubernetes master is running at https://10.147.132.10:8880/r/projects/1a8/kubernetes:6443

Heapster is running at https://10.147.132.10:8880/r/projects/1a8/kubernetes:6443/api/v1/namespaces/kube-system/services/heapster/proxy

KubeDNS is running at https://10.147.132.10:8880/r/projects/1a8/kubernetes:6443/api/v1/namespaces/kube-system/services/kube-dns/proxy

kubernetes-dashboard is running at https://10.147.132.10:8880/r/projects/1a8/kubernetes:6443/api/v1/namespaces/kube-system/services/kubernetes-dashboard/proxy

monitoring-grafana is running at https://10.147.132.10:8880/r/projects/1a8/kubernetes:6443/api/v1/namespaces/kube-system/services/monitoring-grafana/proxy

monitoring-influxdb is running at https://10.147.132.10:8880/r/projects/1a8/kubernetes:6443/api/v1/namespaces/kube-system/services/monitoring-influxdb/proxy

tiller-deploy is running at https://10.147.132.10:8880/r/projects/1a8/kubernetes:6443/api/v1/namespaces/kube-system/services/tiller-deploy/proxy

To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.

Install Helm

Helm is used by OOM for package and configuration management. Hence, we are installing Helm (use 2.3.0 not current 2.6.0) on the server where we have mounted the OOM project.

...

#

Purpose

Command and Example

1

Download the Helm tar file

wget http://storage.googleapis.com/kubernetes-helm/helm-v2.3.0-linux-amd64.tar.gz

Expand

title	Example of wget helm

$ wget http://storage.googleapis.com/kubernetes-helm/helm-v2.3.0-linux-amd64.tar.gz

--2017-11-08 20:12:30-- http://storage.googleapis.com/kubernetes-helm/helm-v2.3.0-linux-amd64.tar.gz

Resolving storage.googleapis.com (storage.googleapis.com)... 216.58.208.48, 2a00:1450:4001:815::2010

Connecting to storage.googleapis.com (storage.googleapis.com)|216.58.208.48|:80... connected.

HTTP request sent, awaiting response... 200 OK

Length: 12568314 (12M) [application/x-tar]

Saving to: ‘helm-v2.3.0-linux-amd64.tar.gz’

helm-v2.3.0-linux-amd64.tar.gz 100%[========================================================================================================>] 11.99M 10.8MB/s in 1.1s

2017-11-08 20:12:32 (10.8 MB/s) - ‘helm-v2.3.0-linux-amd64.tar.gz’ saved [12568314/12568314]

2

Untar the Helm tar file

tar -zxvf helm-v2.3.0-linux-amd64.tar.gz

Expand

title	helm tar file content

$ tar -zxvf helm-v2.3.0-linux-amd64.tar.gz

linux-amd64/

linux-amd64/helm

linux-amd64/LICENSE

linux-amd64/README.md

3

Enable the Helm command

sudo mv linux-amd64/helm /usr/local/bin/helm

Tip of viewing helm command menu

Expand

title	Helm help menu

ubuntu@sdnc-k8s:~$ helm help

The Kubernetes package manager

To begin working with Helm, run the 'helm init' command:

$ helm init

This will install Tiller to your running Kubernetes cluster.

It will also set up any necessary local configuration.

Common actions from this point include:

- helm search: search for charts

- helm fetch: download a chart to your local directory to view

- helm install: upload the chart to Kubernetes

- helm list: list releases of charts

Environment:

$HELM_HOME set an alternative location for Helm files. By default, these are stored in ~/.helm

$HELM_HOST set an alternative Tiller host. The format is host:port

$HELM_NO_PLUGINS disable plugins. Set HELM_NO_PLUGINS=1 to disable plugins.

$TILLER_NAMESPACE set an alternative Tiller namespace (default "kube-namespace")

$KUBECONFIG set an alternative Kubernetes configuration file (default "~/.kube/config")

Usage:

helm [command]

Available Commands:

completion Generate bash autocompletions script

create create a new chart with the given name

delete given a release name, delete the release from Kubernetes

dependency manage a chart's dependencies

fetch download a chart from a repository and (optionally) unpack it in local directory

get download a named release

history fetch release history

home displays the location of HELM_HOME

init initialize Helm on both client and server

inspect inspect a chart

install install a chart archive

lint examines a chart for possible issues

list list releases

package package a chart directory into a chart archive

plugin add, list, or remove Helm plugins

repo add, list, remove, update, and index chart repositories

reset uninstalls Tiller from a cluster

rollback roll back a release to a previous revision

search search for a keyword in charts

serve start a local http web server

status displays the status of the named release

test test a release

upgrade upgrade a release

verify verify that a chart at the given path has been signed and is valid

version print the client/server version information

Flags:

--debug enable verbose output

--home string location of your Helm config. Overrides $HELM_HOME (default "/home/ubuntu/.helm")

--host string address of tiller. Overrides $HELM_HOST

--kube-context string name of the kubeconfig context to use

--tiller-namespace string namespace of tiller (default "kube-system")

Use "helm [command] --help" for more information about a command.

...

Space shortcuts

Page tree

Versions Compared

Old Version 5

New Version 6

Key

Add host name to /etc/hosts file

Clone the OOM project from ONAP gerrit

Install Docker 1.12

Install/Start Rancher server ³

Configure Rancher Client

Install/Start Rancher server

Configure Rancher Client

Create Rancher environment:

Add host to INFRASTRUCTURE

Create Rancher environment:

Add host to INFRASTRUCTURE

Confirm that the host process has completed

Download kubectl on the server

Enable the kubectl command

Generate Config from the Rancher UI

Create the kube config on the server

Validate the kube config

Install Helm

Download the Helm tar file

Untar the Helm tar file

Enable the Helm command

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 5

New Version 6

Key

Add host name to /etc/hosts file

Clone the OOM project from ONAP gerrit

Install Docker 1.12

Install/Start Rancher server 3

Configure Rancher Client

Install/Start Rancher server

Configure Rancher Client

Create Rancher environment:

Add host to INFRASTRUCTURE

Create Rancher environment:

Add host to INFRASTRUCTURE

Confirm that the host process has completed

Download kubectl on the server

Enable the kubectl command

Generate Config from the Rancher UI

Create the kube config on the server

Validate the kube config

Install Helm

Download the Helm tar file

Untar the Helm tar file

Enable the Helm command

Install/Start Rancher server ³