Using the Web Console
The web console lets view and manage your Apcera Platform cluster's resources. You can create jobs from Docker images, create virtual networks and services, create services and promote jobs to providers. The console also displays cluster resource graphs, includes a built-in policy editor, and a searchable audit log.
See Common Web Console Tasks for details on tasks you can perform with the web console.
Logging in to the Web Console
To access an Apcera cluster's web console, open
console.<cluster-name.toplevel.domain> (for example, console.your-cluster.example.com). The first time you access the web console you will be presented with a login screen. To get started, click Sign In.
The Apcera Platform supports different authentication mechanisms for accessing your cluster. Which authentication mechanisms are available depends on how your cluster was configured. Production clusters will typically integrate with a third-party identify provider, such as Active Directory. For example, the login dialog below shows that the cluster supports several authentication mechanism (Google, Keycloak, LDAP, and others).
Note: If you are not able login to the console, clear your browser’s cache and try logging in again.
Note: To enable cross-site requests (for example, in an environment where a load balancer is managing requests to the cluster) using the credentials you used to access Web Console, set the environment variable
lucidjob. Then restart the
lucidjob and refresh the Web Console in your browser.
Console Home page
The console's Home page provides shortcuts for common tasks, such as creating a job from a Docker image or Ubuntu image, links to recently viewed jobs or policy documents, as well as links to video tutorials. Shortcuts are customized depending on your primary role, developer or IT operations.
There are several ways to create jobs using the web console. You can create a job from a Docker image, deploy a multi-resource manifest that creates and configures several jobs at once, or spin-up a capsule running Ubuntu that you can connect to and install packages using
apt-get, for example.
See Creating Jobs in Common Web Console Tasks for details.
To deploy source code from your local computer that is not a Docker image, you must use the
apc app create command (see Deploying an App).
The Jobs section of the left navigation contains links to view and manage different types of jobs. Click the Apps menu item to only list deployed applications, or Capsules to only view deployed capsules. Click All to view jobs of all types. You can also filter the list of jobs by job type, name or any other field.
See common job management tasks for more information.
The Services section of the left navigation contains links to view and manage different types of services in Apcera. Click the Services menu item to list application services you've created, and to create new services. To view a list of service gateways or promote an existing job to a service gateway, click the Gateways menu. To view a list of service providers or create a new provider, click Providers.
See the following for common service management tasks:
Getting Help and Downloading APC
The Help menu also contains links to download APC, the command-line client for managing your cluster, as well the version of your Apcera Platform cluster,
Resources in Apcera are organized by namespace. The namespace navigator is a control in the web console that lets you filter resources according to the namespace in which they are defined. For example, in the following screenshot the Jobs view is filtered to only display those jobs in the apcera namespace.
You can also enter a search term to further filter namespaces by full or partial name. For example, in the following screenshot all namespaces that include "production" are presented in a list you can select from.
You can also filter resources by typing a value in the filter input field. You can filter on all fields or specific fields. For example, in the following image the list of jobs has been filtered to only show those jobs whose Type field is "docker" whose Status is OK.
A new capability as of the the Apcera 3.2.0 release, for instance managers (the INSTANCE MANAGERS tab on the Cluster page), you can also filter on instance manager Tag values as well as the Name field.