Installing the Triton Enterprise end-user portal

Modified: 03 Aug 2016 14:18 UTC

The Triton Enterprise end-user portal communicates to Triton via the CloudAPI and sdc-docker endpoints, and provides a convenient interface for end-users to interact with Triton that complements the command line tools. The Triton end-user portal is available to paid Triton Enterprise customers and is not currently available as open source.

Downloading and importing the images

Portal consists of three components, a single sign-on image (SSO), a storage instance to handle persistent portal data, and the portal image. The links, and instructions for installing these images, will be provided by Joyent Support to customers with an active Triton enterprise support subscription.

Running the installer

The portal installer is run from the head node, in the global zone.

headnode# ./install-portal.sh -h
Usage:
    install-portal.sh <install-server> <portal-user> <company-name> <support-url> <devcenter-url> <fabrics-enabled>

    install-server : Hostname of server for this installation (default=headnode)
    portal-user    : Portal system account (will be created by the installer)
    company-name   : Company name to be displayed on Login page
    support-url    : Web page URL for 'Support' link on Portal
    devcenter-url  : Web page URL for 'Dev Center' link on Portal
    fabrics-enabled: Enable fabric network management in Portal (yes/no)

Example:

headnode# ./install-portal.sh -h
Usage:
    install-portal.sh <install-server> <portal-user> <company-name> <support-url> <devcenter-url> <fabrics-enabled>

    install-server : Hostname of server for this installation (default=headnode)
    portal-user    : Portal system account (will be created by the installer)
    company-name   : Company name to be displayed on Login page
    support-url    : Web page URL for 'Support' link on Portal
    devcenter-url  : Web page URL for 'Dev Center' link on Portal
    fabrics-enabled: Enable fabric network management in Portal (yes/no)

[root@headnode (mxpc) /var/tmp]# ./install-portal.sh

Validating setup and pre-requisites...

Please specify installation parameters:
Install Server [headnode]:
Portal System User [portal]:
Company Name []: Joyent Inc.
Support URL []: https://help.joyent.com
Dev Center URL [https://www.joyent.com/developers]:
Fabrics Enabled (yes/no)? [yes]: no

Installing end-user portal using the following configuration:

Install Server  : headnode
System User     : portal
Company Name    : Joyent Inc. (Data Center: mxpc)
Support URL     : https://help.joyent.com
Dev Center URL  : https://www.joyent.com/developers
Fabrics Enabled : no

Proceed with installation? (yes/no): yes

* * * * * *

Create work dir: /var/portal/updates/20160212T102648Z
Image for sdcsso is up to date
Image for storage is up to date
Image for piranha is up to date
Provisioning sdcsso VM eef5f14e-4fb1-e597-d7e3-d75fbb02e4a3
Provisioning storage VM cece559b-55cd-4b34-c1af-f661e9037491
    sdcsso VM verified
    storage VM verified
Requested unique lookup but found 0 results.
Provisioning piranha VM 92fb9a10-9526-6480-f0a9-a2be41f9221d
    piranha VM verified

Setting up portal user 'portal'
User 'portal' already exists
Key "0c:56:4c:84:1b:91:ea:e1:90:07:25:e0:35:56:9f:d3" added to user "portal"

* * * * * *

Portal installation completed successfully.
Portal URL: http://151.1.224.143:3000

Before using the portal:
- Ensure portal VM can ping the CloudAPI Data Center endpoint, i.e.
    "mxpc": "https://cloudapi.mxpc.joyent.us"
  by having the appropriate resolvers or host entries in the /etc/hosts file.

Defining packages for use by portal

By default, the portal will only provide access to packages that are added to a defined group. By default, this group is named triton, but it can be changed if desired. This allows the operator to only provide a sub-set of packages for use in the portal - for example, this will allow certain packages such as those used for administration or testing to be held back.

You can use the Operations Portal to add the triton group name to the packages on a one by one basis. This can also be done on the CLI using the sdc-papi /packages endpoint.

This example shows the process of adding the triton group to all the sample* packages.

headnode# for PACKAGE in `sdc-papi /packages?name=samp* | json -Hag uuid` ; do
sdc-papi /packages/$PACKAGE -d '{ "group" : "triton"}' -X PUT; done

Logging into portal

You can now use the URL provided by the installer (in this example above, this will be http://151.1.224.143:3000) and log in as any user who has been created in the installation.

Advance portal configuration

Portal can be customized by the Operator in order to comply with site requirements for security, loadbalancing, and high availability. Details are available on the Advanced portal setup page.