Kony Fabric console User Guide: Publish > Use Case

Managing Service Profiles

The Service Configuration Profile Import and Export capability enables you to exchange service configuration parameters of an app between two environments.

Every service profile includes configuration parameters of all the services that are linked to an app. The details of the service profile are available in the form of a JSON file. You can export a service profile from one environment, edit the required service parameters in the JSON file, and then import the updated service profile to another environment.

Service profiles can be versioned in a Git repository and these versions can be used for app upgrades. This provides full portability of a service profile to deploy the profile to new clouds.

Service profiles support is available for Kony Fabric Console and MFCLI. The Export and Import features are in the Publish > Service & Web Client > CONFIGURE and PUBLISH page.

Use Cases

You can use service reconfiguration based on the following scenario:

The use case: Currently, developers have to recreate endpoint configurations as they move from one environment to another environment. For example, you can set up a service profile for a Development environment. When you want to move into QA, you need to reconfigure all the service endpoints. Instead, Kony provides developers the ability to export service configuration profile so that the service profile can be imported into a new environment.

Export/Import Service Profiles using Kony Fabric

To export or import a service configuration profile from the Publish tab, do the following:

In the Publish > Service & Web Client page, select the required environment.
Click CONFIGURE & PUBLISH.

In Service Configuration, click the More Options button. The Import Service Profile and Export Service Profile options are shown in the list.
- To export the service profile, click the Export Service Profile option. The service profile details are downloaded in a JSON file.

To import the service profile, click the Import Service Profile option and navigate to the required JSON file of a service profile.
Important: After you import a service profile, the existing configuration parameters get modified. This modification is based on the data imported before the SAVE & PUBLISH button was clicked.

Click SAVE & PUBLISH to start publishing the updated details in the service profile to the selected environment. The process of publishing the app begins.

Export/Import Service Profiles using MFCLI

You can export or import service profiles by using MFCLI commands for continuous integration.

export-config command

The export-confighelps you to export the Service Profile for the existing services (Integration, Identity and Object), for a given app and an environment. The profile is downloaded as per the specified .json file.

To export a service profile from a Cloud (manage.kony.com) environment

java -jar mfcli.jar export-config -u <user> -p <password> -t <account id> [-f <file name>  [-a <app name>] [-v <app version>] [-e <environment name>]

For example:

java -jar mfcli.jar export-config -u abc@kony.com -p password -t 100054321 -f "C:\\tmp\\Sample.json" -a MyApp_23 -v 1.0 -e MyCloudEnvironment

To export a service profile from an on-premise installation

 java -jar mfcli.jar export-config -u <user> -p <password> -au <Identity URL> -cu <Console URL> [-f <file name>  [-a <app name>] [-v <app version>] [-e <environment name>]

For example:

java -jar mfcli.jar export-config -u abc@kony.com -p password -au http://10.10.24.79:8080 -cu http://10.10.24.78:8081 -f "C:\\tmp\\Sample.json" -a MyApp_23 -v 1.0 -e MyCloudEnvironment

The following arguments are supported for the export-config command:

For example, to get the summary help on all the commands,
java -jar mfcli.jar export-config help 
Usage: Run the self-executable JAR with relevant arguments:

Arguments	Description
-t, --account	Nine-digit ID of the Kony Cloud account (visible on top right corner in Console), for example, 100054321. Not relevant for an on-premise installation.
* -a, --app	Name of the app for which Service Configuration profile is to be exported.
-cu, --console	URL of Kony Fabric Console (without context path), relevant for on-premise installation only. For example, http://10.10.24.78:8081
* -e, --environment	Name of the environment for which a Service Configuration profile is to be exported.
* -f, --file	Name of the file to import or export. For example, C:\\tmp\\Sample.json.
-au, --identity	URL of Kony Fabric Identity Services (without context path), relevant for on-premise installation only. For example, http://10.10.24.79:8080
--mfa	If specified, Multi-Factor Authentication is enabled. The secret key for MFA required for generating one-time password (OTP) needs to be specified in the properties file. The default value is set to `false`
-p, --password	Password for the Kony user account. This could be plain text or, encrypted using 'encrypt' command. This is mandatory.
-u, --user	Kony user required for authentication. For example, abc@kony.com. This is mandatory.
-v, --version	Version of the app for which a Service Configuration profile to be exported. The default version is set to `1.0`

import-config command

The import-config command helps you to import the specified Service Profile in a .json file into the given app and in an environment.

To import a service profile to a Cloud (manage.kony.com) environment

java -jar mfcli.jar import-config -u <user> -p <password> -t <account id> [-f <file name> [-a <app name>] [-v <app version>] [-e <environment name>]]

For example:

java -jar mfcli.jar import-config -u abc@kony.com -p password -t 100054321 -f "C:\\tmp\\Sample.zip" -a MyApp_23 -v 1.0 -e MyCloudEnvironment

To import a service profile to an on-premise installation

 java -jar mfcli.jar import-config -u <user> -p <password> -au <Identity URL> -cu <Console URL> [-f <file name>  [-a <app name>] [-v <app version>] [-e <environment name>]

For example:

java -jar mfcli.jar import-config -u abc@kony.com -p password -au http://10.10.24.79:8080 -cu http://10.10.24.78:8081 -f "C:\\tmp\\Sample.zip" -a MyApp_23 -v 1.0 -e MyCloudEnvironment

The following arguments are supported for the import-config command:

 For example, to get summary help on all the commands,
java -jar mfcli.jar import-config help

Usage: Run the self-executable JAR with relevant arguments:

Arguments	Description
-t, --account	Nine-digit ID of the Kony Cloud account (visible on top right corner in Console), for example, 100054321. Not relevant for an on-premise installation.
* -a, --app	Name of the app for which a Service Configuration profile is to be exported.
-cu, --console	URL of Kony Fabric Console (without context path), relevant for on-premise installation only. For example, http://10.10.24.78:8081
* -e, --environment	Name of the environment for which a Service Configuration profile is to be exported.
* -f, --file	Name of the file to import or export. For example, C:\\tmp\\Sample.json.
-au, --identity	URL of Kony Fabric Identity Services (without context path), relevant for on-premise installation only. For example, http://10.10.24.79:8080
--mfa	If specified, Multi-Factor Authentication is enabled. The secret key for MFA required for generating one-time password (OTP) needs to be specified in the properties file. The default value is set to: `false`
-p, --password	Password for the Kony user account. This could be plain text or, encrypted using 'encrypt' command. This is mandatory.
-u, --user	Kony user required for authentication, For example, abc@kony.com. This is mandatory.
-v, --version	Version of the app for which a Service Configuration profile to be exported. The default version is set to `1.0`.