This is documentation for Apprenda 7 and 8.
Documentation for older versions are also available.

Manage Clouds

Information about the one or more clouds that comprise the Platform can be found in the Clouds page of the SOC. Navigate to the Clouds page from the top navigation menu by going to Infrastructure>Clouds.

On this screen you can see information about the Clouds in your Platform, including the Cloud Name, Cloud URL, Cloud Type, Memory allocation, CPU allocation, the Cloud Provider, and the # (number) of Servers in the Cloud. The Cloud URL, Memory/CPU Capacity, and number of servers, can be viewed--but not changed--from this page. Memory/CPU allotment will be visible only if Resource Throttling is enabled.

Edit Cloud Information

When viewing the Infrastructure>Clouds page, you can edit information about any of the Clouds in your Platform. At least one Cloud is created when when you install the Platform, but if you need to add another or remove an existing Cloud, you can modify your Platform to add or remove a cloud. Additionally, if you want to add to or remove servers from a Cloud, you must modify your Platform to add or remove nodes.

To edit information about an existing Cloud, click Edit Cloud for the Cloud you'd like to edit.

In the Edit Cloud window, you can edit the following information about the Cloud: Cloud Name, Cloud Type (can be Private, Public and Hosted), Description, and Infrastructure provider. You are not able to change the Cloud URL or resource information of any Cloud.

Click Save when all changes have been made (or Cancel to not edit any information).

Edit information about your Cloud in this window

Add Kubernetes Cluster

From the Infrastructure>Clouds page you are able to add an existing Kubernetes cluster to your Platform. Only one cluster can be added per Cloud and it must meet the minimum requirements for the Platform.

To add a cluster, click Add a Cluster for the corresponding Cloud.

Click this button to add a cluster to the Platform

In the Add Cluster window,

  1. fill in the Cluster Name. This will be how the cluster is identified on the Platform

  2. fill in the URL for the cluster. This must be the full URL for the cluster, including http:// or https:// and the port to the Kubernetes API server (default 6443)

  3. choose the Authentication Mode and fill in the corresponding authentication information. This option was introduced in Platform version 7.2.0. If you are on an earlier version, you are only able to provide a username and password for Basic Authorization to the cluster. See more about how the Platform authenticates to the cluster

    • Username/Password: Provide user credentials for a user the Platform Cluster Manager will authenticate with when issuing a request to the Kubernetes API server

    • Client Certificate: Upload a X.509 certificates signed by a Certificate Authority that is trusted by the Kubernetes API server and the corresponding certificate password

  4. provide a comma separated list of host names or IP addresses of cluster nodes to use as Gateway Nodes. The Platform will route traffic through these nodes to the rest of the nodes on the cluster and must be able to reach nodes provided in this window. We recommend that you add at least 2 gateway nodes to handle traffic and to ensure high availability. See more about how gateway nodes are used by the Platform

  5. fill in the Heapster URL. Heapster (https://github.com/kubernetes/heapster) provides monitoring and performance analysis of containers. The Platform uses it (when provided) to gather utilization statistics for pods running on the cluster. If you do not set up Heapter and provide an URL here, the Platform won't be able to access an resource information to display in the SOC

Click Save (or Cancel to not add the cluster).

After saving, the Platform will begin to run some validation on your cluster to make sure it meets the minimum requirements. When validation is complete, you will be redirect to a page that displays how your cluster performed. Note that the Platform will add the cluster to the Cloud even if validation doesn't succeed, however the cluster must pass validation before the Platform can start managing or deploying workloads to it. If you have trouble passing validation, make sure all inputs are correct and re-run validation.

Add information about your Kubernetes cluster in this window

Edit Kubernetes Cluster

After adding a Kubernetes Cluster to a Cloud, you are able to edit information about a cluster it by clicking the Edit next to the corresponding cluster name in the Infrastructure>Clouds page.

This will open the Kubernetes cluster editor window where you can update the following cluster information: Cluster Name, URL, Authentication Mode and corresponding inputs, nodes to use as Gateway Nodes, and the Heapster URL. Authenticaiton Mode and the ability to use a certificate to authenticate to the cluster was introduced in Platform version 7.2.0. On earlier Platform versions, you are only able to provide user credentials (Username/Password) to authenticate to the cluster. See more about how the Platform authenticates to the cluster.

Click Save when all changes have been made (or Cancel to not edit any information). After saving, the Platform will begin to run some validation on your cluster to make sure it meets the minimum requirements. When validation is complete, you will be redirect to a page that displays how your cluster performed. Note that the Platform will update the cluster with the new information even if validation doesn't succeed, however the cluster must pass validation before the Platform can properly manage or deploy workloads to it. If you have trouble passing validation, make sure all inputs are correct and re-run validation.

Validate Kubernetes Cluster

You can validate your cluster from the Infrastructure>Clouds page. The Platform needs to validate your provided cluster information before the cluster can be used for deployments. If you make any adjustments to your cluster, you should run this validation again to make sure that everything will work as the Platform expects. After validation is completed, you will be shown a report card of how the cluster performed. Any errors should be fixed and the cluster re-validated.

To run Platform validation on your cluster, click on the down arrow icon next to Edit for the cluster you want to validate and then click Validate.

Remove Kubernetes Cluster

Removing a cluster from the Platform means that the Platform will no long mange or deploy Pods to the cluster. It will not remove the Platform specific Namespace or any of the Pods deployed to it at the time the cluster was removed.

To remove a cluster from your Platform, click on the down arrow icon next to Edit for the cluster you want to remove and then click Remove.