Log In To and Use the Enterprise Portal

This topic describes how to log in to the Replicated Enterprise Portal as a user, and how to use the features in the Enterprise Portal.

For information about how to access the Enterprise Portal for a customer from the Vendor Portal, see Access a Customer's Enterprise Portal.

Log In To the Enterprise Portal

note

If SAML authentication has been enabled and configured for the Enterprise Portal it will be the preferred login method and attempted automatically. See Configure SAML Authentication (Alpha) below.

Log In From the Invitation Email

Users can log in to the Enterprise Portal after they are invited to join a team. See Invite or Delete Users below.

• Go to your email account and open the automated invitation email. Click Activate your account to log in.

  

  View a larger version of this image

Sign Up for a Self-Service Account

If self-service sign-ups are enabled for the application, users can create an account in the Enterprise Portal without being invited. The primary use case for self-service account creation is to sign up for a trial or community version of the software.

note

For information about how to enable self-service sign-ups from the Vendor Portal, see Enable Self-Service Sign-Ups.

To sign up for a self-service account and log in to the Enteprise Portal:

1. Go to the sign-up page URL.

   note

   For information about how to find the unique sign-up URL in the Vendor Portal, see Share Your Sign-Up URL in Enable Self-Service Sign-Ups.

2. Enter your company name and email address, agree to the terms and conditions, and click Create account.

   The following shows an example of a self-service sign-up page for an application:

   

   View a larger version of this image

3. Go to your email account and open the automated account creation email. Follow the link provided in the email to log in.

About SAML Logins (Alpha)

note

SAML Authentication to the Enterprise Portal is Alpha and subject to change. To access this feature, a feature flag must be enabled for your team. For more information, reach out to your Replicated account representative.

When SAML authentication is enabled and configured for your Enterprise Portal team, you can log in with your single sign-on (SSO) credentials either through your SAML Identity Provider (IdP) or the Enterprise Portal. For more information about how to configure SAML, see Configure SAML Authentication (Alpha) below.

Just-In-Time User Provisioning

The first time that you attempt to log in with SAML using your SSO credentials, if you do not already have an Enterprise Portal account, then your account is automatically created using just-in-time (JIT) user provisioning. JIT is handled differently depending on if you attempt to log in through your IdP or the Enterprise Portal:

• IdP-initiated SAML login attempts always allow for JIT user provisioning
• Enterprise Portal-initiated SAML login attempts allow for JIT user provisioning if your email address has already been invited to the team. See Invite or Delete Users below.

View Install and Update Instructions

This section describes how to view install and update instructions in the Enterprise Portal.

The install and update instructions available in the Enterprise Portal are automatically generated based on the install types and options enabled in the customer's license. For more information about managing the installation types and options, see Manage Install Types for a License.

View Install Instructions

To view install instructions in the Enterprise Portal:

1. Log in to the Enterprise Portal and go to Install.

2. On the panel on the left, if there are multiple installation types available for the customer's license, select the installation type to use (Helm or Embedded Cluster).

   The installation options displayed in the Enterprise Portal are based on the customer's license. For more information, see Manage Install Types for a License.

3. Follow the instructions provided to install. Status indicators track your progress throughout the installation.

   If you exit the Enterprise Portal before completing the installation, you can resume the installation process by clicking Continue installation on the Install page, as shown below:

   

   View a larger version of this image

View Update Instructions

To view update instructions in the Enterprise Portal:

1. Log in to the Enterprise Portal and go to Update.

   For any online instances, the Enterprise Portal displays an Update available button when a new version is available.

2. If an Update available button is displayed, click it to view and follow the update instructions for the given instance.

View Instance Records

Users can view their active and inactive instances in the Enterprise Portal, including the instance status and other details.

note

Air gap instance records do not appear in the Enterprise Portal until the user adds a record by either uploading a support bundle for the instance or manually entering instance information. See Create an Air Gap Instance Record below.

View Active and Inactive Instances

To view instances in the Enterprise Portal:

1. In the Enterprise Portal, go to Updates.

2. Under Active Instances, view details about the active instances. Select View inactive instances to view details about inactive instances.

   View a larger version of this image

   The following table describes the instance details available on the Updates page:

   Field	Description
   Instance ID	The unique identifier for the instance.
   Version	The application version installed.
   Instance status	The status of the instance, based on the status informers configured for the application. For more information, see Enable and Understand Application Status.
   First check-in	The timestamp when the instance first sent data to the Vendor Portal.
   Last check-in	The timestamp when the instance most recently sent data to the Vendor Portal.
   First ready	The timestamp when the instance first reached a ready state. For more information about the ready state, see About Resource Statuses in Enable and Understand Application Status.
   Instance labels	Any labels applied to the instance.

Create an Air Gap Instance Record

Air gap instance records do not appear in the Enterprise Portal until the end customer creates an air gap instance record by either uploading a support bundle for that instance or manually entering instance information.

note

To create an air gap instance record in the Enterprise Portal, the customer license must have the Helm CLI Air Gap Instructions (Helm CLI only) or Air Gap Installation Option (Replicated Installers only) option enabled. For more information, see Create and Manage Customers.

Upload a support bundle for the air gap instance

To create an air gap instance record by extracting instance details from a support bundle:

1. On the Update page, under Air gap instances, click Create air gap instance record > Upload support bundle.

   

   View a larger version of this image

2. In the Extract instance info from a support bundle dialog, upload the support bundle and click Upload bundle:

   

   View a larger version of this image

Manually create an air gap instance record

To create an air gap instance record manually:

1. On the Update page, under Air gap instances, click Create air gap instance record > Enter information manually.

   

   View a larger version of this image

2. In the Manually create air gap instance record dialog, complete the fields and click Create instance.

   

   View a larger version of this image

View Release History

To view the release history in the Enterprise Portal:

1. In the Enterprise Portal, go to Release History.

2. In the Version History panel on the left, select a version to view details about the given release.

View License Details

Customers can view license information, including expiration dates and available features.

To manage licenses in the Enterprise Portal:

1. In the Enterprise Portal, go to License.

2. Under License Details, view license information including the expiration date, status, associated release channels, custom license fields, and more.

   View a larger version of this image

Manage Team Settings

This section includes information about how to manage users, service accounts, and SAML authentication in the Enterprise Portal.

Invite or Delete Users

Customers can invite additional users to the portal and manage their access.

To manage invite and manage users in the Enterprise Portal:

1. In the Enterprise Portal, open the user account dropdown in the top right of the page and select Team settings.

   

   View a larger version of this image

2. Click Users.

3. Manage users as desired:

   • To invite a new user, click Invite user.
   • To delete a user, find the target user in the table and open the menu. Select Delete user.

Manage Service Accounts

To manage service accounts in the Enterprise Portal:

1. In the Enterprise Portal, open the user account dropdown in the top right of the page and select Team settings.

   

   View a larger version of this image

2. Click Service accounts.

3. Manage service accounts as desired:

   • To create a new service account, click Create Service Account.
   • To view a service account token, find the target service account in the table and click View under Token.
   • The revoke a service account's token, find the target service account in the table and open the menu under Actions. Select Revoke.

Configure SAML Authentication (Alpha)

note

SAML Authentication to the Enterprise Portal is Alpha and subject to change. To access this feature, a feature flag must be enabled for your team. For more information, reach out to your Replicated account representative.

note

SAML authentication must be enabled for the customer in the Vendor Portal before they can configure SAML for their Enterprise Portal team. For more information, see Enable SAML Authentication (Alpha).

To configure SAML authentication for your account:

1. In the Enterprise Portal, open the user account dropdown in the top right of the page and select Team settings.

   

   View a larger version of this image

2. Click SAML Authentication.

3. For Service provider information, copy the values provided and use them to configure your identity provider (IdP).

   

   View a larger version of this image

4. Upload the required metadata XML and public certificate from your IdP.

   

   View a larger version of this image

5. After the file upload is complete, the Enable SAML authentication toggle is automatically enabled.

   

   View a larger version of this image

   note

   If you disable SAML authentication, the SAML configuration details that you added to the Enterprise Portal are saved.

Manage User Settings

Each user can manage their settings in the Enterprise Portal, including enabling and disabling email notifications for various system events.

To manage user settings in the Enterprise Portal:

1. In the Enterprise Portal, open the user account dropdown in the top right of the page and select User settings.

   

   View a larger version of this image

2. Edit the user settings as desired:

   • Edit profile information
   • Manage email notification preferences

Collect, Upload, and Manage Support Bundles

End customers can use the portal to collect, upload, and manage support bundles.

To manage support bundles in the Enterprise Portal:

1. In the Enterprise Portal, go to Support.

   

   View a larger version of this image

2. Manage support bundles as desired:

   • For Support Bundle Collection, follow the instructions provided to collect a support bundle based on the environment.

   • To upload a support bundle, click Upload support bundle.

   • To view, download, or delete previous support bundles, select Download or Delete in the Support Bundles table.