Documentation

Project Details-K8s

By clicking the selected project you are redirected to the Servers. Here you can see all servers for the project with their description.

Accessing project's details
Figure.1: Accessing project’s details

Project Info #

Under Servers title is a brief description of a project – such as Project NameProject StatusCloud TypeKubernetes VersionAccess ProfileCloud CredentialsKubernetes ProfileAlerting ProfileAccess IP Address (if you use this address to ssh connect, please do not use user ubuntu, it’s in use by Taikun for managing the cluster) and Kubernetes Health. Some of these include links to e.g. cloud or profiles.

project info
Figure.2: Brief Project Info

You can also see here ETC=Estimated Time to Complete. It is approx time (in minutes) until the cluster will be completed.

etc
ETC

Servers #

Every server is described by IDServer NameIP AddressFlavorCPU/RAM/Disk SizeRoleStatusKuebernetes HealthCreation Time and Actions. If you expand the table, you can see the last modification made (Last ModifiedLast Modified By).

servers
Figure.3: Servers for Project

Server status can be:

  • Deleting
  • Failure
  • Pending
  • Pending Delete
  • Pending Upgrade
  • Ready
  • Updating
  • Upgrading

Actions

show statusShow Status – shows current status from the cloud for 3 seconds

reboot Reboot – choose HARD or SOFT reboot for each server

  • HARD – the power to the system is physically turned off and back again causing an initial boot
  • SOFT – system restarts without the need to interrupt the power
ℹ️
Info

Hard or soft reboot can be chosen only for Openstack. For AWS and Azure there is only simple reboot available.

Actions Buttons #

Upgrade #

Upgrade your version of Kubespray to the latest one. The button is disabled, if your Kubernetes are up to date. Enabling auto upgrade during the project creation, the Upgrade button won’t be available.

Enable/Disable Backup #

You can Enable Backup if you have added the credentials in Backup Credentials and the project isn’t locked. You can do it during the project creation or after the project is created, more info here.

After you enable the backup, you get notified through Notification and you can check the successful status in Kubernetes. In Projects – Kubernetes – Deployment section you should see velero installed

velero
Figure.4: Velero tool

After enabling backup, you should add Backup Policies.

Enable/Disable Monitoring #

Be able to see detailed processes with enabling monitoring. After you enable it, which takes up to 5 minutes, you can preview all tracks with Logs button. The tracking starts the moment Logs button is enabled.

You can enable monitoring before project creation or (if you forgot or have changed your mind) whenever your project is created.

Disable function works the same.

Commit #

Sends the changes to repository.

Once the cluster is committed you will see ETC in project info.

Repair #

When the server’s are Failed or there is some other problem in the cluster, it can be repaired by changing the status to Ready. If all the servers have failed during the first creation, the repair button works as commit and you should use it. If only one server is failed, you should change only the one server’s status, because repair will restart the status of all servers.

repair
Figure.5: Repair

Attach/Detach Alerting Profile #

Attach Alerting Profile if you want to receive a notifications about alerts in your project. Detach if notifications are no longer needed.

Lock/Unlock #

lockLock/unlockUnlock

lock Project is unlocked

Clicking the button you lock a project. You can preview some pages (e.g. Kube Info), but you can’t make any changes in the project (see Project Details – Project info).

unlock Project is locked

Clicking the button you unlock a project and enable action buttons.

Add Server #

To create a new server clickadd server btn button and fill all the fields.

You will receive an error message if no flavor has been bound to your project yet. You can also bind the flavor during project creation.

no flavor bound

Use the link to bind a flavor.

add workers
Figure.6: Add Server

Server Name – only alphanumeric characters and dash are allowed, 1-30 characters.

?
Warning

Letters must be lowercase!

Disk size – should be at least 30GB

Role – you are able to choose from several roles for your servers, which are set according to Kubernetes settings

Flavor – choose from the list of offered flavors (e.g. n0.xlarge)

  • you can bind the flavors from clouds to the project in Flavor Info
ℹ️
Info

Recommendation for sizing:

  • bastion recommended 2 vCPU + 2GB of RAM

  • masters recommended 4 vCPU + 8GB of RAM

Number of Servers – set number for kubeworker or kubemaster, add odd number of masters (min. 3 for a highly available cluster)

?
Warning

The change MUST be committed.

Kubernetes Node Labels – label nodes where you want to sent or restrict pods; you can add more labels with add label button, for more info see Kubernetes docs

For more information see Creating a Cluster.

Function buttons

Between Project Info and Servers are buttons with specific features or more detailed information.

Delete #

Delete the selected server’s. You can delete servers to still have a working cluster (1 bastion, 1 master and 1 worker) or delete the whole working cluster.

?
Warning

The change DOES NOT have to be committed.

History #

This button will redirect you to Audit Log with pre-filled organization and project, so you can preview the changes made for the chosen project.

history
Figure.7: History

Kubeconfigs #

Add a new kubernetes configuration for your profile and project.

add kubeconfig
Figure.8: Add Kube Config

Kubeconfig Name – choose a name for your kubeconfig

Kubeconfig Role

  • cluster-admin – perform any action on any resource, ClusterRoleBinding – gives full control over every resource in the cluster and in all namespaces (or in very resource in the role binding’s namespace – RoleBinding)
  • admin – RoleBinding – allows read/write access to most resources in a namespace, does not allow write access to resource quota or to the namespace itself
  • edit – allows read/write access to most objects in a namespace, does not allow viewing or modifying roles or role bindings, allows accessing Secrets and running Pods as any ServiceAccount in the namespace
  • view – see most objects in a namespace, does not allow viewing roles or role bindings, does not allow viewing Secrets
ℹ️
Info

For more info, see kubernetes documentation.

Application kubeconfig – choose if kubeconfig can be used by other users (all or managers only) or Personal kubeconfig – kubeconfig can be used only by you

You can see all project’s configurations in the table with its IDNameUser NameUser RoleProjectAccessible for all and Actions.

kubeconfig overview
Figure.9: Kubeconfigs

Actions

download This .yaml file can be download and use to organize information about clusters, users, namespaces, and authentication mechanisms.

delete Delete your kube config if it is no longer needed. You can also delete user’s or manager’s kube configs.

Kube Info #

If Kubernetes is active, Kube Info button will take you to the Kubernetes configuration. For more see Projects – Kubernetes.

Events #

You are redirected to Events, where you can see all Kubernetes changes made in the project. To preview details for more information to each action useshow button. A green strip indicates a successful action, a brown strip indicates a failed action.

You can sort Events by:

  • Search field
  • Filling Start and End Date
  • Tick Only failed to filter failed actions
events
Figure.10: Events

Logs #

Preview Kubernetes cluster logs to Grafana.

Logs button is disabled if Monitoring is disabled. To view logs, you must first Enable Monitoring.

logs
Figure.11: Logs

Write your query and use Start date and End Date for sorting. You can also expand every message – red is an added action, without color is other log.

logs details
Figure.12: Logs details

Alerts #

First thing when you access Alerts are Firing Alerts. This section is refreshed every 5 minutes, but you can also use the refresh button to see the most updated data.

firing alerts
Figure.13: Firing alerts

To see all alerts, use upper right Show All Alerts button. As seen above, firing alerts are marked with red color.

You can silence alert and sort all the alerts by firing, silenced, all or resolved.

Alerts are accessible only if Monitoring is enabled and the project is not empty.

firing alerts metrics
Figure.14: Alerts

For each alert you can see details and use a link that will redirected you to Metrics with the query already filled.

The index number at Alerts shows the number of firing alerts. alerts index number When the firing alerts are resolved, the number disappears.

Firing alerts also work from the real-time notifications bell ? in header.

firing alerts notification
Figure.15: Alerts bell

The notification contains a brief message on a specific project and bellow the message is time of the change. After clicking Show Project, you can access the project in which the alert is.

As the name suggests: Mark as Read and Dismiss all.

Metrics #

Write a query, search Prometheus Metrics and preview the value needed.

Modify Step or Date.

Switch between Console and Graph for better results.

metrics
Figure.16: Metrics

Backup Policy #

After you Enable Backup, you have to create a Backup Policy. After clicking the Backup Policy button you get redirected to the new page, where you create a new policy with Add Policy button.

backup policy restores
Figure.17: Add Policy

Name – choose a name for your backup (3-30 characters)

Retention period – how long you want to keep the backup (format e.g. 72h)

Cron period – how often you want to do the backup

  • predefined – choose from selection from the most common periods
  • custom – if you want to specify your own period (format * * * * *)
  • e.g. every hour – 0 * * * *; daily – 0 0 * * *, weekly on Sunday – 0 0 * * 0
    crontab guru with examples

Add Include/Exclude Namespace – specify the special requests that you want to include or exclude from the backup, at least one must be filled

Important

The backup is done with a snapshot method – backup copy used to create the entire copy of servers every chosen time period.


There are three tabs:

Schedules

In Schedules you can find overview of your backup policy.

backup policy schedules
Figure.18: Schedules

show description Show description – see detailed e.g. specification, metadata etc.

delete Delete – stop the backup by deleting the policy

Backups

Backups contain backups from schedules.

backup policy backups
Figure.19: Backups

show description Show description – see detailed e.g. specification, metadata etc.

reset Restore backup – if anything goes wrong, you can restore the backup, which you will then see in Restores tab

delete Delete – delete the backup

Restores

Overview of restores from Backups.

backup policy restores
Figure.20: Restores

show description Show description – see detailed e.g. metadata etc.

delete Delete – delete the restore

Dashboard #

Dashboard is accessible only if cluster is created and monitoring is enabled.

dashboard
Figure.21: Dashboard

Here you can see graphs with Memory and CPU usage for the project. You can also add Query you want.

dashboard query
Figure.22: Add Predefined Query

Name – choose name for your query (e.g. My Query)

Expression – fill in Metrics data (e.g. node_procs_running)

Description – describe your query (e.g. Node Process Running)

What are your feelings