To reproduce

Set up the cluster

1. Download and install Kublr Control Plane documentation
2. Create new Kubernetes cluster using Kublr Control Plane.

When the cluster is up and running,

1. Download the kubeconfig file.
2. Set the KUBECONFIG environment variable export KUBECONFIG=$(pwd)/kubeconfig.

The Kublr Demo/Installer is a simple and convenient demo version of Kublr running in Docker that allows you deploy Kubernetes clusters. You can also install a non-production licensed version of the full Kublr Platform from the Kublr Demo/Installer.

By downloading and using the Kublr Demo/Installer and Kublr, you agree to the Terms of Use and Privacy Policy.

Running Kublr

Linux:

sudo docker run --name kublr -d --restart=unless-stopped -p 9080:9080 kublr/kublr:1.21.2

Windows:

docker run --name kublr -d --restart=unless-stopped -p 9080:9080 kublr/kublr:1.21.2

Kublr Installation Guide

What you should know about the Kublr Demo/Installer

The Kublr Demo/Installer is a lightweight platform that allows you to run a demo or limited functionality, dockerized Kublr version. You can use it to:

• Manage a standalone Kubernetes cluster;
• Manage the full feature Kublr Platform;

The Kublr Demo/Installer stores all data about the clusters inside the Docker container. Therefore, if you delete the Docker container, you will lose all cluster and Kublr platform related data — though you won't lose the cluster and platform itself. The Kublr team recommends using the Kublr Demo/Installer to verify that a Kubernetes cluster can be created in your environment. So, test it before deploying a full and more permanent Kublr Platform in the cloud or on-premise.

Kublr Demo/Installer Installation Prerequisites

1. Download and install Docker
2. 64-bit operating system to run the Kublr Demo/Installer
3. To deploy a Kubernetes cluster or the full Kublr Platform, you’ll need an AWS, Azure, GCP account or an on-premise environment.

Running Kublr

Open a terminal and launch following command:

sudo docker run --name kublr -d --restart=unless-stopped -p HOST_PORT:9080 -e KUBLR_HOST=HOST_IP:HOST_PORT kublr/kublr:1.21.2

Note Hereinafter, "sudo" is Linux specific - omit it to get command for Windows.

• HOST_PORT is a port available both on you workstation for the browser and available outside, from the network;

Here's a Kublr Demo/Installer launch command example:

sudo docker run --name kublr -d --restart=unless-stopped -p 9080:9080 kublr/kublr:1.21.2

The Kublr UI will be available on https://localhost:9080 (admin/kublrbox)

Note There can be a different address depending on your environment. Read carefully for the Kublr in Docker start notification text, as it may contain information about the access adress.

If you are going to set up a bare metal cluster on the Kublr platform, please add this additional parameter KUBLR_HOST, where the HOST_IP is available for cluster nodes:

sudo docker run --name kublr -d --restart=unless-stopped -p HOST_PORT:9080 -e KUBLR_HOST=HOST_IP:HOST_PORT kublr/kublr:1.21.2

If you have already started the Kublr Demo/Installer without the option KUBLR_HOST or your IP address has been changed (for example to switch networks), please use this command to correct the KUBLR_HOST:

docker exec -i kublr /bin/bash -c 'echo "KUBLR_HOST=HOST_IP:HOST_PORT" > /ip.external'; docker restart kublr

Running Kublr in an air-gapped environment

In order to run the Kublr Demo/Installer in an air-gapped environment, please request the launch command via [email](mailto:[email protected]?subject=AirGap Kublr Demo/Installer running command request) or use this contact us form.

The Kublr UI

By default, the Kublr UI, Keycloak UI, and API will be available on the exposed port 9080. After downloading the Docker image, it will take less than a minute for Kublr to start and be viewable.

• The Kublr UI is available on HTTP: https://localhost:9080, use admin/kublrbox for login to Kublr UI;
• Keycloak is available on HTTP: https://localhost:9080/auth, use admin/admin to manage Keycloack;

If you use KUBLR_HOST to define the public IP address and public port number of the host running Kublr (e.g. 192.168.99.234:9981), run this command:

sudo docker run --name kublr -d --restart=unless-stopped -p HOST_PORT:9080 -e KUBLR_HOST=HOST_IP:HOST_PORT kublr/kublr:1.21.2

Navigate to the following URLs:

• https://HOST_IP:HOST_PORT - Kublr UI (admin/kublrbox);
• https://HOST_IP:HOST_PORT/auth - Keycloack (admin/admin);

Complete Your Profile

On first logon into Kublr, you will be prompted to complete your profile. Set your first and last names and valid business email address.

The "valid business email address" means that your email at most public domains (like "[email protected]", "...@ÿahoo.com" etc.) will not be accepted - instead you should use your organization or other private domain.

Connect Kublr and create a Cluster AWS

For instructions on deploying cluster on other supported cloud platforms or baremetal, see Documentation.

Connect AWS and Kublr

1. Log into Kublr using your credentials.
2. On the left menu, click Credentials.
3. Click Add Credentials.
4. Set Credentials Type to "AWS Credentials".
5. Enter Credentials Name.
6. Enter Access Key from AWS Management Console / IAM (see above).
7. Enter Secret Key from AWS Management Console / IAM (see above).
8. Click Save Credentials. The "Credentials have been successfully created" popup will be displayed.
9. To verify if credentials are valid and ready to be used, mouse over the created credentials and click the displayed Test button. Verification success popup will be displayed.
10. Click Ok.

Create a Kubernetes Cluster in Kublr

Powered by Kublr, Vanilla Kubernetes Cluster does not include any advanced Kublr features, but is suitable for running workloads.

To add a new cluster:

1. On the left menu, click Clusters.

2. Click Add Cluster. The Select Intallation Type dialog is displayed.

3. In the Select Intallation Type dialog, click Cluster.

4. Click Continue Setup. The ADD CLUSTER dialog is displayed.

5. In the ADD CLUSTER dialog, set Provider to "Amazon Web Services".

6. From the Credentials list, select previosly created AWS credentials.

7. Specify Cluster Name.

8. Set:

   • Region
   • Kublr Agent (select 1.21.x agent build to install k8s 1.21)

9. Scroll to the Master Configuration section.

10. Specify the parameters of the master node(s) of your cluster as described below.

11. Select Instance Type from the list.

12. From the Masters list, select the number of master or management nodes in correspondence with the selected Instance Type.

13. From the Operating System list, select the host OS for virtual machines in the cluster.

14. Optionally, select Public SSH Key from the list.

15. Scroll to the Instance Group section (default name group1).

16. Specify the parameters of the work node(s) in your group as described below.

17. Select Instance Type from the list.

18. To select the number of work nodes in a group, do one of the following:

    • In the Nodes field, set the number of work nodes.
    • Select the Auto-Scaling option, and then set the Min Nodes and Max Nodes limitations.

19. From the Operating System list, select the host OS for virtual machines in the cluster.

20. If necessary, set your own name for the instance group.

    Note You can also clone or delete the current instance group, or add another one.

21. Optionally, scroll to the Features section.

22. If necessary, add features to your cluster, specifying parameters under:

    • Centralized Logging
    • Centralized Monitoring
    • Ingress Controller

23. Customize the cluster spec. Press Customize Specification link. Editor dialog with full cluster spec in YAML format opens

    • Navigate to .spec.master section.
    • Find existing or add new subsection KublrAgentConfig
    • Add a following YAML code:

    kublrAgentConfig:
      kublr:
        kube_api_server_flag:
          service_account_issuer: '--service-account-issuer=https://kubernetes.default.svc.cluster.local'

1. At the bottom of the editor dialog, click Validate and Install.

   A notification is displayed "Your cluster is being created. It might take a few minutes.".

2. In the notification window, click OK.

   Your new cluster page is displayed on the Events tab showing the cluster creation progress.

After the cluster becomes ready, use Download Kube Config File link on Overview tab. This will download admin kubeconfig file which you can supply to sonobuoy, kubectl, helm and other tools to test and manage your cluster.

Run the conformance test

Download a sonobuoy binary release of the CLI, or build it yourself by running:

$ go get -u -v github.com/heptio/sonobuoy

$ sonobuoy run --mode=certified-conformance

Then the status commands $ sonobuoy status indicate that the execution is completed, you can download the results.

$ outfile=$(sonobuoy retrieve)

untar the tarball, then add plugins/e2e/results/{e2e.log,junit_01.xml}

$ mkdir ./results; tar xzf $outfile -C ./results