User Interface

Updated: August 11, 2021
Contents

The DevOps module on the CloudBlue Connect platform is used to add and configure your services. Furthermore, this module is used for monitoring your deployment environments and accessing your logs and events. Follow the instructions below to add and successfully configure your service on the Connect platform.

Adding Services

Click the Add Service button to launch a wizard. This wizard helps users create a new service instance.

Follow the wizard steps to add a service on the Connect platform:

  1. General: Enter your service instance name(required) and specify its description (optional).
  2. Product: Select your required product from the following list.
  3. Summary: As a result, the system generates a service instance and provides a summary.

Click the Go to Details button to access your added service instance. Otherwise, click Close to close the summary.

Service Details

Once your service is added to the DevOps module, click on your service from the provided list to access the Service Details screen.

The Service Details screen displays your selected product, specified name and specified description. Click the Edit button at the top-right corner of the screen to edit service name or your description. In addition, the vertical ellipsis () button enables users to delete their service on the Connect platform.

Removing Services

Note that it is possible to delete a service only in case all of your environments are stopped or disconnected.

The Service Details screen enables Connect users to access Developer(Dev), Production(Prod) and Staging (Test) environments via corresponding tabs on the user interface. The system provides the following sections within each tab:

  • Environment: This section displays your environment mode (Local or Cloud) and its status (Disconnected, Connected, Running or Stopped). Enable or disable your environment by using corresponding buttons on the user interface. Click the Edit button to configure your environment as described below. In case the Cloud mode is connected, this section also displays your deployed container instances, CPUs and memory. Furthermore, this section also displays your specified Git repository and provides links to your readme and changelog files.
  • Local Access: This section is available in case the Local mode is selected. This section provides an Environment ID that is used to to process your environment queue locally. Copy the link by using the corresponding icon from this section.
  • External Events: This section provides a JWT secret that is required to forward external events to your selected environment. Show/hide or copy your JWT secret by using corresponding icons within this section.
  • Environment Variables: Specify your environment variables with this section. Click the Add button to define a new value for your required variable. In addition, import or export your variables list by using corresponding buttons in this section. Click on the edit icon to change a variable from the list. Delete your variable by clicking on the vertical ellipsis () icon.
  • Tasks Queue: Use this section to examine tasks queue for your environment. For example, this queue may include pending fulfillment requests or tier configuration request that should be processed by Vendors systems. Note that in addition to processing tasks queue instances, the DevOps module allows you to schedule and reschedule your tasks.

Once your environment is successfully connected, the Service Details screen also displays the following sections within the environment tabs:

  • Stats: This section provides resource monitors that shows your CPU, Memory and Network utilization. Switch between your hour, day and week statistics by using the corresponding buttons in this section.
  • Capabilities: This section displays capabilities that are supported by your extension project. Review your enabled capabilities as described below.
  • Events: Use this section to review event logs of your selected environments in the Cloud mode. Note that the system uses the logz.io service with a Kibana UI to generate your event logs, create alerts, and more. 

Furthermore, the Audit Trail tab within the Service Details screen represents a security-relevant chronological record that provides auditors with a set of service events and activities. This tab also includes event date, actors, technical details (such as browser details, OS, software, etc.) and event summary.

Environment Configuration

Access the Service Details screen and click the Edit button from the Environment section to start configuring your selected environment. Therefore, the system provides a wizard that helps users with the following configuration:

Mode

Select either the Cloud mode or Local mode in the provided list. The Cloud mode deploy your environment to your specified Git repository, while the Local mode, as the name implies, deploys your environment locally.

Click the Next button to continue.

Repository

Specify your Cloud repository and authorization details in the following form. Note that this wizard step is available only in case the Cloud mode is selected.

  • Git Repository URL: Provide a link to your Git repository.
  • Requires authorization: Check this checkbox in case your repository requires authorization.
    • Username: Enter your Git username if authorization is required.
    • Password: Specify your password in case authorization is required.

Click Next to continue.

Tag

Specify your repository tag in the following form. This wizard step is available only in case the Cloud mode is selected.

Click the Save button to finalize your environment configuration.

Summary

As a result, the system provides an environment configuration summary.

Make sure that your provided summary is correct and click the Close button to close it.

Environment Variables

Access the Service Details screen and click the Add button under Environment Variables to define a new value for your environment variable.

Note

Environment Variables are required to work with the extension project. Refer to the Extension Project documentation for more details.

Specify your environment variable key (e.g., ASSET_REQUEST_APPROVE_TEMPLATE_ID) and its value (e.g., activation template value: TL-262-572-051).

In case the Secured checkbox is checked, the provided value will be encrypted. Thus, this value can be used only by your extension project.

The system also enables to instantly apply values for your environment variables by clicking the Apply Change button once their values are successfully specified.

Task Details

In case your task is failed, the system allows examining your failed task details, such as a task category, error message, and more. Refer to the Extension Project documentation to learn the difference between various task categories within the DevOps module.

Locate your failed task under Task Queue via your added Service Details screen. Thereafter, click on the vertical ellipsis () icon and select Details to access the Task Details screen.

Note that the system allows you to manually restart your failed task. Click the Retry button from the Task Details screen. Therefore, the system will process your selected task once again.

Logging

In case your environment is deployed in the Local mode, your logs will be generated locally. However, if your environment is running in the Cloud mode, your generated logs will be displayed within your added service details screen on Connect. Logs are used to receive detailed information about request state changes, unhandled exceptions and other events. The system allows switching logging levels as follows:

Click the Settings button in the Events section of the Service Details screen. The system prompts you to select one of the following logging levels:

  • Error: An error represents a major issue or a failure of an important process. Errors are usually associated with database connection drops or with the inability to access required files or services. Thus, errors are often require immediate attention.
  • Warning: This logging level indicates that the system detected a problem or an unusual event. For instance, in case a user tries to invoke a service and this service fails to connect the first time. Consequently, this service can be connected on an automatic retry and the system registers this unexpected or unusual event. Warnings do not represent major issues; however, it is recommended to investigate your warnings.
  • Info: This logging level is used to register regular events and normal application behavior. It allows understanding what is happening within your service and the system. For example, when your service is stopped or started to work.
  • Debug: This logging level features more granular and detailed information. This provides diagnostic data for developers, sysadmins, etc.

Note that the system also allows utilizing the logz.io service to access logging data within the Kibana interface. Click the Open in the Logz.io button to access this service.

Capabilities Review

Once your extension project is successfully configured and your environment is deployed, the Connect platform allows examining your specified extension capabilities. Note that these capabilities are defined during the extension project bootstrap operation.

Access your added service details screen. Thereafter, click the Details button under Capabilities to review your selected capabilities.

The Subscription tab displays your selected subscription processing capabilities and subscription validation capabilities. Note that Connect displays enabled statuses for each of the fulfillment request types that are supported by your extension project.

Next, the Tier Config tab, as the name implies, provides your enabled tier request processing and tier request validation capabilities. The system also showcases enabled statues for each tier request types.

Lastly, the Product tab is used to review the product action and custom event capabilities. Refer to the Extension Project documentation in case more detailed information on any of the displayed capability is required.

Is this page helpful?
Translate with Google
Copied to clipboard