Documentation

User

Brief Introduction #

 User #

With user role you don’t have that much privileges and option like manager or partner role, but you can create clusters and manage them, see the overview of projects, servers or cloud credentials for your organization, manage your account and more.

In this guideline you can see how to login, use the dashboard or create a cluster.

Visit LoginDashboardProjects or My Profile to see more.

Login to Taikun #

First-time login #

After you receive the token in your mail, it will redirected you to the new page to create a new password.

?
Warning

The password should meets its conditions: 1 uppercase, 1 lowercase, 1 number, 1 non-alphanumeric and at least 6 signs long (e.g. Test@123)!

reset password
Figure.1: Reset new password

If you did not manage to use the token in time (3 hours), click Resend Token button and use the new token in your e-mail.

resend token
Figure.2: Resend token

Login #

Enter your E-mail and the created Password then click LOGIN button. The LOGIN button is disabled until you fill in both fields.

login
Figure.3: Login process

You are immediately redirected to the Dashboard.

Wrong Credentials #

If you enter the wrong password, you receive the error message Bad credentials.

bad credentials
Figure.4: Bad credentials

Forgotten password #

If you don’t remember your password, use Forget your password? button.

forgotten password
Figure.5: Forgotten password

A token is sent to your e-mail, clicking the link you will be redirected to the page where you can reset your password like when you want to login for the first time.

Dashboard #

You can access the Dashboard by clicking upper left Taikun logo or the Dashboard in the tabs:

Dashboard and Project tabs
Figure.1: Dashboard and project tabs

On Dashboard you can find:

  • Users
  • Pie charts (Projects, Server Statuses, Servers, Cloud Credential, Nodes Overview, Pod overview, Project with Alerts and Kubernetes Health)
  • Tables (Kubernetes, Project Resource Allocation and Recent Events)

On every page in the upper right corner you can see:

Icons upper right
Figure.2: Header icons
Logo of your organization
  • logo of your organization
Docs
  • link to this documentation, variable for every page
Search
  • global search – search for projects or servers, case insensitive, can be open with double shift at every page
    • Taikun search – search through projects
    • Kubernetes Search – have to be checked (as searching kubernetes takes longer time) and search through all active kubernetes
Notifications
  • real-time notifications
    • General – notifications about changes made in projects (e.g. created project, enable monitoring, change of status), for details see Dashboard – Recent Events
    • Alerts – new/persisting (red) or resolved (green) alerts, see Projects – Alerts
My Profile
  • your information and setting, see My Profile
  • if your display name is changed, the name can be seen in the corner User Role

Users #

Shows how many Users are involved in your organization.

Users

To find the information about your profile visit My Profile.

Charts #

Projects #

The graph shows number of Projects (right corner) for your organization and the pie chart shows their current status (pointing arrow at some part of the graph):

  • Failed
  • Succeeded
  • Pending
  • Updating
Projects
Figure.1: Projects

By clicking the specific part in graph, you see an overview of selected projects.

For more information visit Projects.

Server Statuses #

In the right corner is number of Servers and the pie chart shows their current status (pointing arrow at some part of the graph):

  • Failed
  • Succeeded
  • Pending
  • Updating
Server Statuses
Figure.2: Server statuses

By clicking the specific part in graph you see an overview of selected servers.

Servers #

In the right corner is shown number of all Servers for your organization. The graph shows where the servers are hosted (AWSAzureOpenStack). When you point at a column, exact number of servers used is shown.

Servers
Figure.3: Servers

Cloud Credentials #

In the right corner is shown number of Cloud Credentials. The graph shows which cloud (AWSAzureOpenStack) and how many of each type are used. When you point to a column, the exact number of cloud credentials used is shown. In the right corner is number of all cloud credentials.

Ciloud Credentials
Figure.4: Cloud credentials

Nodes overview #

In the right corner is shown number of Nodes and the pie chart shows their current status (pointing arrow at some part of the graph):

  • Healthy
  • Unhealthy
Nodes Overview
Figure.5: Nodes overview

By clicking the graph you see Kubernetes overview, where you can find Projects with number of Healthy and Unhealthy Nodes.

Pods overview #

In the right corner is shown number of Pods and the pie chart shows their current status (pointing arrow at some part of the graph):

  • Healthy
  • Unhealthy
Pods Overview
Figure.6: Pods overview

By clicking the graph you see Kubernetes overview, where you can find Projects with number of Healthy and Unhealthy Pods.

Projects with Alerts #

In the right corner is shown number of all alerts and the pie chart shows how many alerts has each project (pointing arrow at some part of the graph):

Projects with Alerts
Figure.7: Project with alerts

By clicking the graph you see Kubernetes overview, where you can find Projects with number of alerts.

For more information see Projects – Alerts.

Kubernetes Health #

In the right corner is shown number of Non-Healthy items and the pie chart shows status for all projects with active kubernetes (pointing arrow at some part of the graph):

  • Healthy
  • Unhealthy
  • Warning
  • Unknown
Kubernetes Health
Figure.8: Kubernetes health

By clicking the graph you see Kubernetes overview, where you can find Projects (with kubernetes) with its kubernetes health status.

For more information see Projects- Health.

Tables #

Kubernetes #

The Kubernetes chart consists of 3 main sections:

  • Project
  • Nodes
  • Pods
Kubernetes
Figure.1: Kubernetes

Projects

In the right corner you can switch between Projects with Kubernetes (to which you are assigned to).

Nodes

Lists Nodes by Name and shows status of DiskMemoryPIDs and Ready (Status of the Node).

Status: working Status: working

Status: not working Status: not wokring

Pods

For every Pod (characterized by Pod Name) is listed its NamespaceNodeRestart CountAge and Status.

If the status is failed, you can check the pod in Kubernetes section – use the link in Nodes – Metadata Name or Pods – Pod Name.

Node/Pod failure
Figure.2: Node/Pod failure

For more information see Projects – Kubernetes.

Project Resource Allocation #

In this section you can see how the usage of CPUsRAM and Disk Size are divided between the individual projects. The last column Total shows the sum of all projects for CPURAM or Disk Size. You can also sort CPURAM and Disk Size by Usage or Limit (if there is any).

Project Resource Allocation
Figure.3: Project resource allocation

The pie charts shows percentage of usage of each project:

Green - small usage Green – small usage

Yellow - normal usage Yellow – normal usage

Orange - higher usage Orange – higher usage

Red - full usage Red – full usage

Recent Events #

Lists 10 events from the latest. Green ones are successful events, red ones are failed. The update button is in the right corner.

Recent Events
Figure.4: Recent events
?
Warning

If there is a real-time change, you are notified Notifications ?

Notifications
General

Whenever user makes a change (create project, add backup, delete project etc.) you are notified via bell ? at the top of the page.

The colors indicate:

  • green – successful action
  • red – failed action
Notifications - General
Figure.5: Notifications – General
Alerts

Notifications for projects when alert starts or is resolved (e.g. Kubernetes health status), you are also notified via bell ? at the top of the page.

  • green – resolved problem
  • red – problem
Notifications - Alerts
Figure.6: Notifications – Alerts

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

ℹ️
Info

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

Projects #

On the Projects tab, you can preview all existing projects to which you are assigned.

Projects
Figure.1: Projects

Each project is described by following information:

ID, Project Name, Organization Name #

Changeless descriptions for each Project.

View #

Link to your Kubernetes or Virtual Machines part of your project.

Status #

Status shows the current status and actions of your servers in the project in real-time. Below are all possible statuses listed with their description.

  • Ready
    • all servers in the project are ready without any issues
  • Deleting
    • one or more servers in your current project are being deleted
  • Failure
    • one or more servers failed during the action for any reason (for instance during boot or creation)
  • Pending
    • one or more servers are in a pending state, which means that, for instance, they have not yet been created on the hosted platform
  • Updating
    • one or more servers in the project are being updated by Taikun during the creation process
  • Upgrading
    • one or more servers upgrade Kubernetes, cloud credentials or others

Health #

This column describes a condition of the project cluster. Keep in mind that a good-working project should be always Healthy.

  • Healthy
    • cluster id without any further problems
  • None
    • cluster is probably empty, there is nothing to check
  • Unhealthy
    • problems with connection to Kubernetes or Monitoring API
  • Unknown
    • cannot connect Kubernetes API
  • Warning
    • minor issues

Creation Date #

The exact time stamp when the project was created.

Kubernetes Version #

Shows current Kubernetes version for each project.

Cloud Type #

Shows which provider is hosting your project cluster

  • AWS
  • Azure
  • OpenStack

K8’s #

Kubernetes active Kubernates active

Kubernetes not active Kubernetes not active

Expiration Date #

See durability of a project. By default, the expiration date of project is set to infinity.

?
Warning

After the expiration date, your project is NOT affected, deleted or lock. It will stays the same.

Show hidden columns #

Click small arrow on the right side of the table to see more details.

Expanded table
Figure.2: Expanded table

Expand the table to see:

  • Alerts count – number of firing alerts in a project
  • Created By
  • Last Modified
  • Last Modified By

Sorting #

Projects can be sorted by Project NameStatusCreation DateK8s versionCloud Type and Expiration Date. Also the search bar can be used to find some specific project.

Project Details – K8s #

By clicking the selected project or K8s View you are redirected to the Kubernetes Servers. Here you can see all K8s 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 the project – such as Project Name (with locked/unlocked image), Project StatusCloud TypeKubernetes VersionAccess Profile, Cloud CredentialsKubernetes ProfileAlerting ProfilePolicy 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.

Project Info
Figure.2: 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
Figure.3: ETC

Servers #

Every Server is described by IDServer NameIP AddressFlavorCPU/RAM/Disk SizeRoleStatusKubernetes Health and Creation Time. If you expand the table, you can see the last modification made (Created ByLast ModifiedLast Modified By).

Servers for Project
Figure.4: Servers for project

Server status can be:

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

Actions #

Upgrade #

Upgrade your version of Kubespray to the latest one. The button is disabled, if your Kubernetes are up to date. Also if you checked Auto Upgrade during creation.

Commit #

Sends the changes to the 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, use repair button.

Repair
Figure.5: Repair
?
Warning

If the project is locked ? which you can see under Project Info, you can only preview some pages (e.g. Kube Info). You can’t make any changes.

Add Server #

To create a new server clickadd server button button and fill all the fields. You, as user, can’t delete servers – think twice which and how many servers you want to create.

Add Server
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 the Kubernetes settings

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.

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

ℹ️
Info

Recommendation for sizing:

* bastion recommended 2 vCPU + 2GB of RAM

* masters recommended 4 vCPU + 8GB of RAM

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.

Function buttons #

Under Add Server are buttons with specific features or more detailed information.

Function Buttons
Figure.7: Function buttons

Kubeconfigs #

Add a new kubernetes configuration for your profile and project.

Add Kubeconfig
Figure.8: Add kubeconfig

Kubeconfig Name – choose a name for your kubeconfig (3-230 characters)

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.

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 allKonfig Role NameCreated By and Actions.

Kube Configs
Figure.9: Kube configs

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.

K8s 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 useshowbutton. A green strip indicates a successful action, a red strip indicates a failed action. Use Clear events for deleting all the events.

You can sort Events by:

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

Logs #

Preview Kubernetes cluster logs to Grafana. Logs button is disabled if Monitoring is disabled.

Logs
Figure.11: Logs

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

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. For each alert you can see details and use a link that will redirected you to Metrics with the query already written.

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

Alerts
Figure.14: Alerts

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 the header. Red ones are indicate alert, green ones means that the alert is resolved.

Alerts bell
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

Project Dashboard #

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

Project Dashboard
Figure.17: Metrics

Here you can see graphs with Memory and CPU usage for the project. You can also see added Query from Manager or Partner.

Project Details – VMs #

By clicking VMs button in Servers page or VMs View in Project page you are redirected to the VMs Servers. Here you can see all virtual machines for the project with their description.

Accessing Project's details - VMs
Figure.1: Accessing project’s details

Project Info #

Under Servers title is a brief description of the project – such as Project Name (with locked/unlocked image), Project StatusCloud Type or Cloud Credentials.

Project Info
Figure.2: Project info

When there is some operation going on, you can also see here ETC=Estimated Time to Complete. It is approx time (in minutes) until the cluster will be completed.

ETC
Figure.3: ETC

Servers #

Every Server is described by IDNameFlavorIP AddressPublic IP AddressStatusProfileImage and Created. If you expand the table, you can see the last modification made (Created ByLast ModifiedLast Modified By).

Servers for Project
Figure.4: Servers for project

Server status can be:

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

Actions #

Commit #

Sends the changes to the repository.

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

Repair #

When the server’s are Failed, use repair button.

Repair
Figure.5: Repair

Add VM #

To create a new server clickAdd VM button and fill all the fields. You, as user, can’t delete servers – think twice which and how many servers you want to create.

?
Warning

For creating the VM: Image has to be bound and Stanalone Profile has to be created. Please contact your manager if these fields are empty.

Add VM
Figure.6: Add VM

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

?
Warning

Letters must be lowercase!

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

Image – choose from the list of offered images (e.g. ubuntu-20.04)

Volume Size – minimal size is automatically filled in when you select image, you can only increase the volume size number

Volume Type – optional, choose from drop down selection

Profile – choose Standalone profile

Count – how many VMs you want to create

Public IP – check if you want to enable public IP

Cloud-init – optional, if set it will override the ssh key from standalone profile

Tags – enter Key and Value

Disk – enter Name, choose Size and select Volume Type

ℹ️
Info

If the project is locked ? which you can see under Project Info, you can’t use Commit, Repair or Add VM.

 

Kubernetes #

To access Kubernetes go to Projects – Servers – K8s Info or use the K8s buttonkubernetesin Projects.

Access Kubernetes
Figure.1: Access kubernetes

In Kubernetes tab can be found:

  • Nodes
    • MessageReasonStatus and Type
  • Deamon Set
    • NamespaceNameStatus and Age
  • Persistent Volume Claim
    • NamespaceNamePhaseSizeStorage Class Name and Age
  • Deployment
    • NamespaceNameStatus and Age
  • Config Map
    • NamespaceName and Age
  • Secret
    • NamespaceName and Age
  • Sts
    • NamespaceNameStatus and Age
  • Service
    • NamespaceNameTypeExternal IP and Age
  • Pods
    • NamespaceNameNode NameAgeStatusRestart CountKill PodTerminal and Logs
  • Ingress
    • NamespaceNameHosts and Age
  • Ingress
    • NamespaceNameHosts and Age
  • CRD (Custom Resource Definition)
    • NameGroupList KindSpec name kindLabels and Age
  • PDB (Pod Disruption Budgets)
    • NamespaceName and Created At
?
Warning

Please do NOT deploy any apps in monitoring Service, because Taikun uses the monitoring namespace heavily! And if you disable the monitoring, all pvc in monitoring will be deleted.

Kubernetes
Figure.2: Kubernetes

You can use sort buttons or search button in each section for easier searching.

ℹ️
Info

Except Pods tab are all tabs for preview only.

Actions #

Show description Show description – for all tabs except Nodes

Pods #

Kill Pod #

Pod can be killed with Kill Podkill podbutton.

Terminal #

Open Terminal to control your container/s.

Terminal
Figure.3: Terminal

Logs #

Logs record events happening in cluster. You can check the logs for more details. To search the logs visit Projects – Project Details – Logs.

Logs
Figure.4: Logs

My Profile #

You can access your profile and its settings by clicking my profile in the right upper corner of the page.

My Information #

Here you can see your User NameOrganization NameSubscription End DateE-mail and Role.

my information
Figure.1: My Information

Settings #

settings
Figure.2: Settings

In Settings section you can:

  • Change your password
  • Change your e-mail
  • Enable e-mail notifications from Taikun
  • Delete Account

Change E-mail #

You just need to type your new e-mail, which you want to use in the future.

change mail
Figure.3: Change email

Your e-mail address is changed but not confirmed, which is indicated with red cross ✖ next to your e-mail in My Information.

Not confirmed e-mail
Figure.4: Not confirmed e-mail

Clicking the Confirm E-Mail button will send the confirmation token to the e-mail address provided by you. Use the link in the mail to confirm your mail. If the link redirects you to homepage of Taikun, please login first and click the link in the e-mail again.

Token expires after 1 hour and then you need to send it with Confirm E-mail button again.

mail verified
Figure.5: Confirmed email
ℹ️
Info

You can’t change e-mail address until your current one is confirmed.

Change Password #

To change your password, you have to insert your current password (old) and new (different) one.

Password should contain at least 1 uppercase, 1 lowercase, 1 number, 1 non alphanumeric and minimum length is 6 signs (e.g. Test@123).

?
Warning

If you receive an error during changing the password, please check it meets the conditions.

change password
Figure.6: Change password
?
Warning

After confirming the password (by clicking the update button), you are logged off and need to log in with the new password.

Delete Account #

If you no longer wish to use Taikun, permanently delete your account. You will lose all access to Taikun.

What are your feelings