docs/installation-k8s1node.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. ===============LICENSE_START=======================================================
   4 .. Copyright (C) 2019-2020 AT&T Intellectual Property
   5 .. ===================================================================================
   6 .. This documentation file is distributed under the Creative Commons Attribution
   7 .. 4.0 International License (the "License"); you may not use this file except in
   8 .. compliance with the License.  You may obtain a copy of the License at
   9 ..
  10 .. http://creativecommons.org/licenses/by/4.0
  11 ..
  12 .. This file is distributed on an "AS IS" BASIS,
  13 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 .. See the License for the specific language governing permissions and
  15 .. limitations under the License.
  16 .. ===============LICENSE_END=========================================================
  17
  18
  19 Script for Setting Up 1-node Kubernetes Cluster
  20 -----------------------------------------------
  21
  22 The it/dep repo can be used for generating a simple script that can help setting up a
  23 one-node Kubernetes cluster for dev and testing purposes.  Related files are under the
  24 **ric-infra/00-Kubernetes** directory.  To get started, clone the repository on the
  25 target VM:
  26
  27 ::
  28
  29     git clone https://gerrit.o-ran-sc.org/r/it/dep
  30
  31
  32 Configurations
  33 --------------
  34
  35 The generation of the script reads in the parameters from the following files:
  36
  37 - etc/env.rc: Normally no change needed for this file.  If where the Kubernetes cluster runs
  38   has special requirements, such as running private Docker registry with self-signed certificates,
  39   or hostnames that can be only resolved via private /etc/hosts entries, such parameters are
  40   entered into this file.
  41 - etc/infra.rc: This file specifies the docker host, Kubernetes, and Kubernetes CNI versions.
  42   If a version is left empty, the installation will use the default version that the OS package
  43   management software would install.
  44 - etc/openstack.rc: If the Kubernetes cluster is deployed on Open Stack VMs, this file specifies
  45   parameters for accessing the APIs of the Open Stack installation.  This is not supported in Amber
  46   release yet.
  47
  48
  49 Generating Set-up Script
  50 ------------------------
  51
  52 After the configurations are updated, the following steps will create a script file that can be
  53 used for setting up a one-node Kubernetes cluster.  You must run this command on a Linux machine
  54 with the 'envsubst' command installed.
  55
  56 ::
  57
  58   % cd bin
  59   % ./gen-cloud-init.sh
  60
  61 A file named **k8s-1node-cloud-init.sh** would now appear under the bin directory.
  62
  63
  64 Setting up Kubernetes Cluster
  65 -----------------------------
  66
  67 The new **k8s-1node-cloud-init.sh** file is now ready for setting up the Kubernetes cluster.
  68
  69 It can be run from a root shell of an existing Ubuntu 16.04 or 18.04 VM.  Running this script
  70 will replace any existing installation of Docker host, Kubernetes, and Helm on the VM.  The
  71 script will reboot the machine upon successful completion.  Run the script like this:
  72
  73 ::
  74
  75   % sudo -i
  76   # ./k8s-1node-cloud-init.sh
  77
  78 This script can also be used as the user-data (a.k.a. cloud-init script) supplied to Open Stack
  79 when launching a new Ubuntu 16.04 or 18.04 VM.
  80
  81 Upon successful execution of the script and reboot of the machine, when queried in a root shell
  82 with the kubectl command the VM should display information similar to below:
  83
  84 ::
  85
  86   # kubectl get pods --all-namespaces
  87   NAMESPACE     NAME                                   READY   STATUS       RESTARTS  AGE
  88   kube-system   coredns-5644d7b6d9-4gjp5               1/1     Running      0         103m
  89   kube-system   coredns-5644d7b6d9-pvsj8               1/1     Running      0         103m
  90   kube-system   etcd-ljitest                           1/1     Running      0         102m
  91   kube-system   kube-apiserver-ljitest                 1/1     Running      0         103m
  92   kube-system   kube-controller-manager-ljitest        1/1     Running      0         102m
  93   kube-system   kube-flannel-ds-amd64-nvjmq            1/1     Running      0         103m
  94   kube-system   kube-proxy-867v5                       1/1     Running      0         103m
  95   kube-system   kube-scheduler-ljitest                 1/1     Running      0         102m
  96   kube-system   tiller-deploy-68bf6dff8f-6pwvc         1/1     Running      0         102m