Platform v7.0.0- Post Deployment Process

An Installation Engineer is required to perform a few steps after SmartOps deployment is completed. The steps related to core-platform are:

Generate Offline Token

To generate an offline token for an organization, login to Master Organization and follow the steps below:

1. Click on Manage Tokens corresponding to the organization as shown in FigureFigure.

   

   This displays the token window as shown below

   

2. Click on the icon to copy the offline token.

 

Note: Ensure that you generate offline token for Ustglobal Organization.

Also ensure to inform the Deployment team about the new offline token, so that it can be updated in the key vault secret and containers will be restarted.

Hostnames (Updates) for configurations related to internal service invocation

In Kubernetes environment, the internal service names have changed when compared to Swarm environment. So, for internal service communications, all the hostnames of the services are now prefixed based on the domain. That is, based on the domain and region, the hostname will differ. This is applicable for areas where service URLS are configurable.

Example Scenarios:

• Clones Engine can now be accessed in SmartOps DI Platform internally as "http://smartops-dev-clones-engine:9090" (earlier this used to be http://clones-engine:9090). In QA, the prefix will change to smartops-qa. In PaaS ITOps DI, this will become http://itops-dev-clones-engine:9090 and so on.

• If you need to call any other service through micro action, you can follow this pattern.

• Another example is the case with elastic search Sense Channel where elastic search URL is configurable through UI. In such cases, Elastic Search URL becomes http://smartops-dev-elasticsearch:9200 for Platform DI environment.

Note: Only the name of the service has been changed as part of Kubernetes implementation, and no further changes in service side. Users can get the full list of applicable service names from Dev-Enablement team. 

Update Workflow shared Variables and reload cache

Workflow shared variables are certain variables which can be used in workflows. The default variables are saved in DB. Based on the installed environment, it is required to edit certain variables.

An installation engineer should ensure that the following variables are changed based on the environment. An API is currently available and can be used to edit the variables. After editing the variables, invoke another API to reload the cache. The details are given below:

API to edit variables:

Method: PUT URL: https://<hostname>/designer/api/clones/dashboard/orgnworkflows/updateSharedVariable/{variableId} Headers: offline-token or Authorization, user and Organization-key RequestBody :  {   "sensitiveFlag": 0,   "variableName": "string",   "variableValue": "string" } PathVariable : variableId

 

Note:

• In Kubernetes based deployment, the variable value changes according to the domain name. So choose the correct domain names accordingly (the correct domain name for each installation can be checked with Dev Enablement team). The following table is an example for K8 SmartOps Dev environment for an Organization with ID, 1:

Variable ID	Org ID	Variable Name	Variable Value
1	1	clones.engine.host	http://<host-name>:<Port> Example: http://smartops-dev-clones-engine:9090
10	1	clones.dialog.host	http://<host-name>:<Port> Example: http://smartops-dev-clones-dialog:8082
16	1	nlp.ice.url	http://<host-name>:<Port>/api/parse/predict Example: http://smartops-dev-ice-xd-rest:8021/api/parse/predict
21	1	clones.queue.host	<rabbitmq-host>  Example: smartops-dev-rabbitmq

 

• As another example, In the ITOPs DI environment the variable value for clones.engine.host is: -clones.engine.host -http://itops-dev-clones-engine:9090

• To link XD project, ensure that you update the service ID of XD project, the details are:

 

• Similarly, if there are any other workflow shared variable that needs to be edited based on any change in client implementation, it can be done.

• If for an Organization ID, you are not sure about the Variable ID to be used, you can invoke the fetch API to fetch all the details of shared variables of an organization.

API to fetch all variables:

Method: GETURL: https://<hostname>/designer/api/clones/dashboard/orgnworkflows/fetchSharedVariable Headers: offline-token or Authorization, Organization-key

 

API to reload cache:

Method: POST URL: https://<hostname>/clonesengine/api/clones/engine/core/executions/reloadWorkflowSharedVariables Headers : offline-token or Authorization, Organization-key

 

Clear engine cache to reload workflows when multiple engine instances are available

This step needs to be performed only if multiple engine instances are running, and during runtime, there are changes to workflows or creation of new PWF projects.

If multiple engine instances are running in an environment, changes in workflows may result in issues. This can happen whenever a workflow is created/updated/deleted or a new PWF project gets created (because during project creation, new project-based workflows get created) and the cache doesn’t get invalidated in all the running engine instances, thus preventing reloading of the workflows in all running engine instances.

 

It is recommended to  trigger an API to reload the workflows until a resolution is available for the problem.
So,  whenever a workflow gets created/updated/deleted/new PWF project gets created, ensure the following API is triggered multiple times from Postman. You may decide the number of times API is to be trigerred based on the number of engine instances.

Note: To be on the safe side, this can be triggered at least 10 times if there are 2 or 4 engine instances.

URL: https://<hostname>/clonesengine/api/clones/engine/core/executions/cleardbcache Method: POST Headers: offline-token or Authorization, Organization-key

  
Note: 

• As mentioned above, project based workflows gets created along with projects. So, right after creating the project, this API needs to be triggered multiple times. Only then, the workflows will get reloaded to cache. After this step, when project installation is initiated, it will work fine. 

• But, if after creating the project, installation of the project is initiated without triggering this API, there is a high possibility that the installation workflow will not run, as the workflow may not be available in that specific engine instance’s cache. 

Clear Keycloak Cache

This step needs to be done only if clones-upgrade container was run for the deployment. To clear the Keycloak cache, follow the steps mentioned below:

1. Login to Keycloak Master Admin console.

2. Select any of the Realms and in Realm Settings and go to Cache tab.

3. Click on all the three Clear buttons (Realm Cache, User Cache and Keys Cache) to clear cache in all realms.

Note:

• This process is required only if the clones-upgrade program was run as part of deployment.

• In case the person who is doing the post-deployment steps are not aware of the deployment procedures completed, this can be executed.

 

PWF/Product/Component Association and De-association with Organization

For each environment, the de-association/association of PWFs, products, components in respective environments/instances (namely, core platform, ITOps, Invoice PWF) can be done. This will include the de-association of monitoring/support PWFs after data migration, as well as the association of new ITOps PWF and these steps are done via API.

 

Postman Collection contains sample request/response samples for the various APIs for association and de-association. It is on need basis that these need to get executed. For actual usage, these should be replaced with appropriate values for host, headers and request body. PFB the details of each of these APIs:

Postman collection available at: (https://ustglobal.sharepoint.com/:u:/r/teams/InnovationEngineering/Shared%20Documents/Knowledge%20Management/SmartOps%20Deployment/7.0.0/7.0_CorePlatform_PostmanCollection.zip?csf=1&web=1&e=UuTsda)

 

1. Invoke the SmartOps Login API for the applicable Organization.

   URL: POST https://<host_name>/pwf/api/smartops/login Body: {"realm":"<orgname>","userName":"<user_name>","password":"<password>"}

    

2. Invoke the Get all PWFS, Products and Components (stacks) API with the following parameters to fetch all available PWFS, products and components:

   URL: GET https://<host_name>/pwf/api/smartops/pwf/fetch-smartops-capabilities Headers: Organization-name–Unique identifier for the organization. Authorization –Access token generated after invoking SmartOps login API (offline token can also be used) user –User Id

   
   Note: This API response provides the details of the PWFs, products and components available and it is based on these values the input for the rest of the APIs given below can be derived.

3. Invoke the Add Product and PWF association API to add or associate applicable PWFs and Products in the required Organization.

   URL: PUT https://<host_name>/pwf/api/smartops/pwf/create-pwf-or-product-association Headers: Organization-name –Unique identifier for the organisation. Authorization –Access token generated after invoking SmartOps login API (offline token can also be used) user –User Id Body: {"componentId": <component_id>,"componentType":"<component_type>"} Component ID –Unique identifier of the package workflow or product (copied from previous step) Component Type –pwf / product

    

   
   Note: Repeat this step for every PWF / product to be associated to the organization.

4. Invoke Disable PWF Association API if you need to de-associate any PWF from an organization.

   URL: PUT > https://<host_name>/pwf/api/smartops/pwf/disable-pwf-association?pwfId=<pwf_id> Headers: offline-token or Authorization, user and Organization-key Param: <pwf_id>

   Note: Disabling PWF association will only disable the association of PWF with that organization. If there are any active projects associated wit that PWF, these projects should be de-activated or deleted to avoid further executions of these projects.

5. Invoke Remove Product Association API if you need to de-associate any Product from an organization.

   URL: DELETE > https://<host_name>/pwf/api/smartops/pwf/remove-product-association/<product_id> Headers: offline-token or Authorization, user and Organization-key Param: <product_id>

    

6. Associate/De-Associate components/stack to a Product or a PWF
   The details are as follows: 

   1. API details to Associate Stacks with PWF/Product:

      URL: PUT https://<hostname>/pwf/api/smartops/pwf/add-component-association Headers: offline-token or Authorization, user and Organization-key Body: {"componentId":<component_id>,"componentType":"<component_type>","stacks":[<list_of_stacks>]}

   2. API details to De-associate Stacks from PWF/Product:

      URL:DELETE https://<hostname>/pwf/api/smartops/pwf/remove-component-association Headers: offline-token or Authorization, user and Organization-key Body: {"componentId":<component_id>,"componentType":"<component_type>","stacks":[<list_of_stacks>]}

       

Note:

1. Replace request body with corresponding values of componentId, componentType, stack.

2. The componentType can be either product/pwf.

3. The componentId is the corresponding id of the product or pwf

4. The stacks should be list of applicable components which needs to be associated for the product/pwf.

5. The values of the componentId and the stack can be obtained from the API which fetches all PWFs, Products and Components (api/smartops/pwf/fetch-smartops-capabilities)

iHub – Configuration

<To be added>
‎

Archiva setup

Use below configurations to setup Archiva for proxy environments where network accessibility is not there:

 

 

 

For more on Archiva please refer:

http://clones-dev.southindia.cloudapp.azure.com:8080/smartops-dev-guide/archiva/

Creating Organizations and adding Users

• Organizations are the enterprise users for whom the SmartOps capabilities are offered.

• A Master Administrator has the privilege to manage organizations for SmartOps.

• Creating an Organization consists of the following sections

  • Create realm for a new organization

  • Defining Web Redirect URI for the Organization

Create realm for a new organization

To create a new organization in SmartOps, follow the steps mentioned below:

1. Access the Master User Interface. The Master UI login page is displayed as shown in FigureFigure.

   

2. Enter the user credentials (Master Admin) in the Username and Password field.

3. Click Sign in. SmartOps Master UI home page is displayed as shown in FigureFigure.

   

4. Click Organizations tab. By default, Organization is displayed.

5. Click on the icon near Organizations. The window for creating a new organization is displayed as shown in FigureFigure.

   

6. Enter the name of the organization in the Organization Name field.

7. Click Add. The SmartOps Master UI home page is refreshed with the new organization as shown in FigureFigure.

   

Defining Web Redirect URI for the Organisation

To define the web redirect URI for the new organization, follow the steps mentioned below:

1. Click on Edit Organisation corresponding to the organisation in FigureFigure. 

   
   This will open the Keycloak Administration UI where you can create an Organization Administrator user and do other configurations.

2. Click on Clients tab from the menu options available on the left-hand side of the screen and select smartops-frontend from the Clients as shown in FigureFigure.

   

3. Enter the URI in Valid Redirect URIs and Web Origins field as shown in FigureFigure.

   

4. Click Save. The success message is displayed as shown in FigureFigure.

   

Add Users and Assign Roles

Master Administrator can add users such as Admin, Installation Engineer, and Skills Designer through Master UI. The Roles and Permissions corresponding to each Package Workflow is detailed in the section Appendix: PWF Roles and Permissions To add users and assign corresponding roles, follow the steps mentioned below:

1. Click on Edit Organisation corresponding to the organisation as shown in FigureFigure.

   
   This will open the Keycloak Administration UI where you can create an Organization Administrator user and do other configurations.

2. Click on Users tab from the menu options available on the left-hand side of the screen and click Add User as shown in FigureFigure.

   

   The Add User screen is displayed as shown below.

   

3. Enter the username in the User Name field. You may also enter all other optional fields. Click Save.

4. Select the user from the list. You may search from the Search field.

5. Navigate to Role Mappings tab and add the required roles from the Available Roles block.

6. To add a role, select the required role from the Available Roles block and click on Add selected icon as shown in FigureFigure.

   
   

   You may assign roles as per requirement of the Package Workflow required as shown below. For example: Admin, Installation Engineer and Skills Designer Roles.

   

7. You may also assign password for the user. To assign password:

• Access Manage Password window through Credentials tab as shown in FigureFigure.

  

 

• Enter the password in Password field.

• Confirm the password in Password Confirmation field.

• Mark the password as temporary or not in the Temporary field.

• Click Reset Password. The password reset successfully message is displayed.

New Roles and Permissions for Core Platform

New roles have been added for iHub and these can be added to applicable users based on the requirement:

• ihub_administrator – admin user for iHub

• ihub_user – normal user for iHub

Following permissions have been newly introduced (this is just for understanding purpose and there is no action required as part of post deployment):

Permissions	Description	Associated Roles
ihub_channel_listing	List iHub channels	Ihub Administrator, Ihub User
ihub_channel_edit_conf	Edit iHub channel configuration	Ihub Administrator
ihub_channel_enable_disable	Enable or disable iHub channels	Ihub Administrator
ihub_channel_view_conf	View iHub channel configuration	Ihub Administrator, Ihub User
smartops-component-access	Access SmartOps Components	Skill Designer, Portfolio Manager, Installation Engineer, Ihub Administrator, Ihub User

 

 

 

 

Feedback

Copyright © 2021 UST Global. All Rights Reserved.