SAP-samples / fsm-extension-installer-kyma

Use this sample to deploy, build, and refine the integration between an SAP FSM extension application and a Kyma system. It can be cloned and enhanced with logic to meet specific business needs.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

REUSE status

SAP FSM Extension Installer for Kyma

Customers can use this sample to quickly deploy the SAP FSM extension application on Kyma system. It can accelerate the building and refinement of the integration between the SAP FSM system and Kyma system. Customers can clone and enhance it with their own logic to meet their own specific needs, which enables the integration to be continuously improved with the use of customers.

This extension installer has been verified on Kyma version <= 1.13.0.

How to set up extension installer

Prerequisites

In order to install extension installer in Kyma, you must fulfill the following requirements:

  1. You must have set up Kyma connection with FSM and created an Application in Kyma by following the guide.

Installation Process

  1. Open the Kyma console and create a Namespace where you want to deploy the extension installer.

  2. Create bindings for Application that you have created in Kyma.

    a. Navigate to the application and click + Create Bindings.

    b. Select the namespace that you created in step 1 and disable Select all of Services & Events.

    c. Select Extension Catalog API. Then save it.

    Important: Note down the application name as you will need it in step 5.

  3. Create service instance for Application that you have created in Kyma.

    a. Navigate to the namespace that you created in step 1.

    b. Select Catalog in left navigation sidebar. Then switch to Services and navigate to the service that corresponds to the Application that you have created in Kyma.

    c. Click Add once to provision a service instance. Enter a service instance name and save it. And you can see your instance in Kyma console under Instance.

    Important: Note down the service instance name as you will need it in step 5.

  4. Register extension installer addon.

    a. Select Addons in left navigation sidebar.

    b. Click Add New Configuration and fill out the following data. Then click Add and you can see this new addon is displayed with "Ready" status.

    • Enter an addon name.
    • Enter github.com/SAP-samples/fsm-extension-installer-kyma/addons/index.yaml as Urls.
  5. Provisioning extension installer addon instance.

    a. Select Catalog in left navigation sidebar. Then switch to Add-Ons and select the addon "FSM Extension Installer For Kyma".

    b. Click Add to provision an addon instance and fill out the following data. Then click Create and you can see this new addon instance is displayed with "PROVISIONING" status and it changes to "RUNNING" status finally.

    • Enter an addon instance name.
    • Choose Default plan.
    • Enter application name that you created in section Prerequisites.
    • Enter service instance name that you created in step 3.
    • Enter the exact Kyma version.

    NOTE: The version number has to match exact (major.minor.patch). You can find the Kyma Version in the bottom left area on your Kyma Console UI. If your Kyma Version is older than 1.11.x, follow step 1 in the Kyma Documentation.

    c. After completing the provisioning, select Instances in left navigation sidebar. There should be one instance named "Extension Catalog API" under "Services" tab and also another instance named "FSM Extension Installer For Kyma" under "Add-Ons" tab in Status "RUNNING".

    The extension installer should now be ready to use.

  6. [Optional] Upgrade to the latest version of extension installer as needed by following these steps:

    a. Delete the extension installer addon instance that was provisioned in step 5.

    b. Delete the extension installer addon that was registered in step 4.

    c. Redo step 4 and step 5.

Known Issues

If you are disabling and enabling the SAP Extension Factory in SAP Field Service Management after you have performed all the above steps. Your Kyma-Configuration described in this guide may not work anymore. You will need to clean up your Kyma-Configuration and repeat the steps described in this guide.

How to obtain support

In case you find a bug or need support, please open an issue here.

License

Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.

About

Use this sample to deploy, build, and refine the integration between an SAP FSM extension application and a Kyma system. It can be cloned and enhanced with logic to meet specific business needs.

License:Apache License 2.0


Languages

Language:TypeScript 83.4%Language:Mustache 13.1%Language:Shell 1.9%Language:Dockerfile 1.1%Language:JavaScript 0.5%