Access StarlingX Kubernetes¶

This section describes how to use local/remote CLIs, GUIs, and/or REST APIs to access and manage StarlingX Kubernetes and hosted containerized applications.

Local CLIs ¶

To access the StarlingX and Kubernetes commands on controller-0, follow these steps:

Log in to controller-0 via the console or SSH with a sysadmin/<sysadmin-password>.
Acquire Keystone admin and Kubernetes admin credentials:
```
source /etc/platform/openrc
```

StarlingX system and host management commands¶

Access StarlingX system and host management commands using the system command. For example:

system host-list

+----+--------------+-------------+----------------+-------------+--------------+
| id | hostname     | personality | administrative | operational | availability |
+----+--------------+-------------+----------------+-------------+--------------+
| 1  | controller-0 | controller  | unlocked       | enabled     | available    |
+----+--------------+-------------+----------------+-------------+--------------+

Use the system help command for the full list of options.

StarlingX fault management commands¶

Access StarlingX fault management commands using the fm command, for example:

fm alarm-list

Kubernetes commands¶

Access Kubernetes commands using the kubectl command, for example:

kubectl get nodes

NAME           STATUS   ROLES    AGE     VERSION
controller-0   Ready    master   5d19h   v1.13.5

See https://kubernetes.io/docs/reference/kubectl/overview/ for details.

Remote CLIs ¶

Documentation coming soon.

GUI ¶

Note

For a virtual installation, run the browser on the host machine.

StarlingX Horizon GUI¶

Access the StarlingX Horizon GUI with the following steps:

Enter the OAM floating IP address in your browser: https://<oam-floating-ip-address>:8443.

Discover your OAM floating IP address with the system oam-show command.
Log in to Horizon with an admin/<sysadmin-password>.

Kubernetes dashboard¶

The Kubernetes dashboard is not installed by default.

To install the Kubernetes dashboard, execute the following steps on controller-0:

Use the kubernetes-dashboard helm chart from the stable helm repository with the override values shown below:

cat <<EOF > dashboard-values.yaml
service:
  type: NodePort
  nodePort: 32000

rbac:
  create: true
  clusterAdminRole: true

serviceAccount:
  create: true
  name: kubernetes-dashboard
EOF

helm repo update

helm repo add kubernetes-dashboard https://kubernetes.github.io/dashboard/

helm install dashboard kubernetes-dashboard/kubernetes-dashboard -f dashboard-values.yaml

Create an admin-user service account with cluster-admin privileges, and display its token for logging into the Kubernetes dashboard.

cat <<EOF > admin-login.yaml
apiVersion: v1
kind: ServiceAccount
metadata:
  name: admin-user
  namespace: kube-system
---
apiVersion: v1
kind: Secret
type: kubernetes.io/service-account-token
metadata:
  name: admin-user-sa-token
  namespace: kube-system
  annotations:
    kubernetes.io/service-account.name: admin-user
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: admin-user
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: cluster-admin
subjects:
- kind: ServiceAccount
  name: admin-user
  namespace: kube-system
EOF

kubectl apply -f admin-login.yaml

kubectl -n kube-system describe secret $(kubectl -n kube-system get secret | grep admin-user | awk '{print $1}')

Access the Kubernetes dashboard GUI with the following steps:

Enter the OAM floating IP address in your browser: \https://<oam-floating-ip-address>:32000.

Discover your OAM floating IP address with the system oam-show command.
Log in to the Kubernetes dashboard using the admin-user token.

REST APIs ¶

List the StarlingX platform-related public REST API endpoints using the following command:

openstack endpoint list | grep public

Use these URLs as the prefix for the URL target of StarlingX Platform Services’ REST API messages.