Getting Started

This section is a tour of the two main dashboards of the tenant console. It also helps with the creation of cluster profiles and clusters to enable users to get going. More details on creating clusters are available in the dedicated clusters page.

Understanding the tenant console

The Spectro Cloud tenant console contains two main dashboards. The first one is mainly for the Kubernetes-related options while the other is for the settings related to operations. There are also differences in the dashboard views for an admin user and a non-admin user.

Default Dashboard

Upon login, the dashboard shows the views available for a non-admin user. At this time, only the cluster profiles (marked as 1) of the default project are shown. Projects (2) help to organize the cluster resources in a logical grouping. The left pane in this dashboard also contains options for clusters (3). The bottom left contains buttons for the user's profile (6) and the Admin dashboard (5). The "Admin" options are visible only for users having the admin role.

The "Settings" section (4) of the default dashboard relates to the cloud account settings. This is an important distinction from the settings under the Admin dashboard.

1
2
3
4

default_dashboard_new_1

5
6

default_dashboard_new_2

Admin Dashboard

The menu within the Admin dashboard also contains the Projects button. This is different from the Projects menu in the default dashboard. Within the Admin dashboard, the Projects button provides access to modifying a project itself (edit/configure/delete and the overall status), whereas the button in the default dashboard provides access to the cluster profiles inside of the project.

The Cluster Profiles button in the Admin dashboard provides access to all the cluster profiles. These cluster profiles can be used in one or more projects, or they can be left unused. An ideal use-case of this feature is for the admin to create cluster profiles that are standard across the tenant (i.e., these cluster profiles are needed in all projects).

The Roles (and Permissions); as well as Users and Teams allow the admin to set or restrict these attributes for one or more team members. See the RBAC section for more details.

Settings under the Admin dashboard provide access to the pack registries; private cloud gateways and SAML SSO configurations.

Finally, audit logs in the admin dashboard allow the admin to track the user interaction with the application resources along with the timeline for all projects and users. For admin users, the "audit log" button is visible for each project as well. Here, the admin can view the logs of the resources specific to the project.

admin_dashboard

Deploying your first cluster

Deploying your first cluster should be a walk in the park. As an overview, Spectro Cloud mandates the creation of a cluster profile before a cluster can be created. This is because the cluster profiles contains the configurations needed for your cluster. The cluster profile helps you prepare a readymade configuration of - at a minimum - the OS, the Kubernetes layer, the network layer, and the storage layers. These four are the mandatory layers without which a cluster profile cannot be created. There are a host of other layers and components available to add in the cluster profile (load balancers, authentication, monitoring, and logging, etc.) which will be detailed in the cluster profile section.

Your First AWS Cluster

The guided documentation guide below is prescriptive with the names and selections. We highly recommend you follow the guide verbatim for your first AWS cluster.

The following steps will be taken to provision your first AWS cluster:

  • Create Cluster Profile.
  • Add AWS Cloud Account.
  • Provision Cluster.

Cluster Profile

  • Navigate to the Default Project (select back to the Default project if you’re in the Admin view).

  • Switch to the Cluster Profiles page from the left navigation bar.

  • Click on the Add Cluster Profile button.

  • Specify the name ExperimentalAWS and click Next.

  • Select Amazon (AWS)for the cloud selection.

  • Click on Edit Layers.

  • Please designate the following selections for each layer, leaving the default configuration:

    • OS: Ubuntu, 18.04.X (LTS)
    • Kubernetes: select version 1.17.X
    • Network: Calico 3.10.X
    • Storage: Amazon EBS 1.0.X
    • Additional layers:
      • Monitoring: Prometheus - Grafana 9.7.X
      • Monitoring: Kubernetes Dashboard 2.0.X
      • Logging: Elastic-Fluentd-Kibana (EFK) 6.7.X
  • Click on Finish to close the Layer dialogue.

  • Click on Next and review the Cluster Profile.

  • Click on Finish to create the Cluster Profile.

Cloud Account

Cloud Accounts are where access credentials are stored for public and private clouds. It is used by the system to provide new cluster infrastructure and cluster resources.

Prerequisites: You need your own cloud account with appropriate permissions to create EC2 VMs and AMIs. Please ensure that your cloud account has at least the following configurations: Cloud Account Permissions. Please import an SSH keypair into your account in the region of us-east-1.

Also, this exercise creates a new VPC/Nat gateway/Elastic IP, so please confirm that your account has sufficient quota for the creation.

Steps:

  • Navigate to the Default Project (select back to the Default project if you’re in the Admin view).

  • From the left-hand main menu, select Settings.

  • Click on Add AWS Cloud Account.

    • name: ca-aws-1
    • Access Key: your <AWS access key>
    • Secret Key: your <AWS secret key>
  • Click on Validate.

  • Click on Confirm to finish creating your cloud account.

Cluster

For the quick-start guide, we’ll provision a new cluster consisting of a single master and a single worker node:

Steps:

  • Navigate to the Default Project (select back to Default p.roject if you’re in the Admin view)

  • Navigate to the Clusters page from the left-hand menu.

  • Click on Create cluster (and follow the wizard):

    • Name: cluster-aws-1
    • Select the cluster profile: ProductionAWS, click Next.
    • Leave the pack parameter overrides as-is, click Next.
    • Cloud Properties:
  • Cloud Account: ca-aws-1

  • Region: us-east-1

  • SSH keyname: <select imported key>

  • Do not select (deselect): Static Placement

  • Click on Next.

  • In the node pool configuration:

    • For the Master node pool, pick the following properties:
  • Instance type: t3.large (General Compute)

  • Availability Zone: us-east-1a

  • For the Worker node pool, pick the following properties:

    • Instance type: t3.large (General Compute)
  • Availability Zone: us-east-1a

  • In the final Review step, click on Deploy.

  • Wait for the cluster to become Active (check the Overview tab). Feel free to click on the Events tab to see the orchestration steps.

Once the cluster is provisioned - feel free to try the following: