Start writing Shell service controller manual

Development/DocSources/en/Shared/concepts/c_ControllerConcepts.xml

@@ -17,15 +17,14 @@
  audience="os"> for a virtual system in OpenStack</ph><ph audience="vmware"> for a VM in vSphere</ph><ph
  audience="azure"
  > for a virtual machine in Azure</ph>, the Subscription service asynchronously triggers the corresponding actions in <ph
- audience="shell">Shell</ph><ph audience="aws">AWS</ph><ph audience="os">OpenStack</ph><ph audience="vmware"
+ audience="shell">a Shell</ph><ph audience="aws">AWS</ph><ph audience="os">OpenStack</ph><ph audience="vmware"
  >vSphere</ph><ph audience="azure"
  >Azure</ph> through the <b>Asynchronous Provisioning Platform (APP)</b> and the <ph audience="shell"
  ><b>Shell service controller</b></ph><ph audience="aws"><b>AWS service controller</b></ph><ph audience="os"
  ><b>OpenStack service controller</b></ph><ph audience="vmware"><b>VMware service controller</b></ph><ph
  audience="azure"><b>Azure service controller</b></ph>: <ph audience="shell"
- >Scripts are executed in a Shell</ph><ph audience="aws"
- >Virtual servers are created or deleted in AWS</ph><ph audience="os"
- >Virtual systems are created or deleted in OpenStack</ph><ph audience="vmware"
+ >Scripts are executed in a Shell</ph><ph audience="aws">Virtual servers are created or deleted in AWS</ph><ph
+ audience="os">Virtual systems are created or deleted in OpenStack</ph><ph audience="vmware"
  >VMs are created, modified, or deleted in vSphere</ph><ph audience="azure"
  >The virtual machine and - if requested - additional resources are created or deleted in Azure</ph>. </p>
  <p id="cmp2"

Development/DocSources/en/Shared/gettingstarted/intro_availabledoc.xml

@@ -67,6 +67,10 @@
  ><i>VMware vSphere Integration:</i> A PDF manual for operators describing how to offer and use virtual machines provisioned on a VMware vSphere server through services in <ph
  conref="../Product_Name.xml#ProductNameTopic/Product_Abbr"
  />.</ph></li>
+ <li><ph id="VMWARE_Guide:_concept_conbody_section_ul_l"
+ ><i>Shell Integration:</i> A PDF manual for operators describing how to use Shell scripts through services in <ph
+ conref="../Product_Name.xml#ProductNameTopic/Product_Abbr"
+ />.</ph></li>
  <li><ph id="Online_Help:_concept_conbody_section_ul_l"
  ><i>Online Help:</i> Online help pages describing how to work with the administration portal of <ph
  conref="../Product_Name.xml#ProductNameTopic/Product_Abbr"

Development/DocSources/en/ShellIntegration.ditamap

@@ -70,7 +70,7 @@
  <topicref format="dita" href="Shared/Installation/c_Update.xml" type="concept"/>
  </chapter-->
  <chapter format="dita" href="ShellIntegrationGuide/Services/c_ServicesIntro.xml" type="concept">
- <topicref format="dita" href="Shared/concepts/c_ControllerPrerequisites.xml" type="concept"/>
+ <topicref format="dita" href="ShellIntegrationGuide/Services/c_ControllerPrerequisites.xml" type="concept"/>
  <topicref format="dita" href="Shared/tasks/t_CreateTechService.xml" type="task"/>
  <topicref format="dita" href="Shared/tasks/t_CreateMarkService.xml" type="task"/>
  </chapter>

Development/DocSources/en/ShellIntegrationGuide/About/c_Readers.xml

@@ -9,7 +9,7 @@
  <title>Readers of this Manual</title>
  <conbody>
  <section>
- <p>This manual is intended for operators who want to offer Shell services on a marketplace provided by <ph
+ <p>This manual is intended for operators who want to use Shell scripts for offering services on a marketplace provided by <ph
  conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"
  />. It assumes that you have access to an existing <ph
  conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"

Development/DocSources/en/ShellIntegrationGuide/About/intro_abbrev.xml

@@ -16,10 +16,6 @@
  <entry><b>APP</b></entry>
  <entry>Asynchronous Provisioning Platform</entry>
  </row>
- <row>
- <entry><b>AWS</b></entry>
- <entry>Amazon Web Services</entry>
- </row>
 
  <row product="oscm_ee">
  <entry><b><ph conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"/></b>

Development/DocSources/en/ShellIntegrationGuide/Administrating/c_AdministratingIntro.xml

@@ -5,7 +5,7 @@
 ]>
 
 <concept id="concept_1BCF5C425D7D4627AB1C66A085CF6E11" xml:lang="en-us">
- <title>Administrating the AWS Integration</title>
+ <title>Administrating the Shell Integration</title>
  <conbody>
  <p>The following sections describe administration tasks you may need to perform in your role as an operator of the Shell integration software.</p>
  </conbody>

Development/DocSources/en/ShellIntegrationGuide/Intro/c_Components.xml

@@ -20,8 +20,7 @@
  </p>
  <p conref="../../Shared/concepts/c_ControllerConcepts.xml#controller/cmp1"/>
  <p conref="../../Shared/concepts/c_ControllerConcepts.xml#controller/cmp2"/>
- <p>Amazon EC2 allows customers to provision and use virtual servers on which to run their applications. Each virtual server is based on an Amazon Machine Image (AMI). An AMI serves as the basic unit of deployment for services delivered with Amazon EC2. AWS customers can either request pre-configured AMIs or they can create their own images. They can provision their images with a variety of operating systems and load them with custom application environments.</p>
- <p>When APP is deployed, an AWS service controller is also deployed, registered, and initialized. </p>
+ <p>When APP is deployed, a Shell service controller is also deployed, registered, and initialized. </p>
  </section>
  </conbody>
 </concept>

Development/DocSources/en/ShellIntegrationGuide/Intro/c_Introduction.xml

@@ -8,22 +8,15 @@
  <section>
  <p
  conref="../../Shared/concepts/c_WhatIsBES_Controller.xml#concept2311/is_a_set_of_services_which_concept_conbody_p_1"/>
- <p>The Shell integration allows users to install any software or execute any task in a Windows environment by running Shell scripts. </p>
+ <p>The Shell integration allows users to install any software or execute any task in a UNIX environment by running Shell scripts. </p>
  <p>When integrating applications with <ph conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"
  />, the instance provisioning can be done in two provisioning modes: synchronous or asynchronous mode.</p>
  <p>Asynchronous provisioning is required if provisioning operations take a long time because long-running processes or manual steps are involved. This is the case, for example, when provisioning virtual machines on a virtual machine server. <ph
  conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"
  /> supports the integration of such applications with its asynchronous provisioning platform (APP). This is a framework which provides a provisioning service as well as functions, data persistence, and notification features which are always required for integrating applications in asynchronous mode.</p>
- <p>The integration of Shell scripts with <ph
- conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"
- /> provides for an Infrastructure as a Service (IaaS) solution that leverages the features of both products: Through services, which are published on a marketplace in <ph
- conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"
- />, users can request and use Shell scripts. The usage costs can be calculated and charged by means of the <ph
- conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"/> billing and payment services.</p>
  <p>When deploying the <codeph>oscm-app</codeph> container provided with <ph
  conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"
- />, a Shell service controller is preconfigured and registered with the asynchronous provisioning platform (APP). This service controller can be used for executing Shell scripts with <ph
- conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"/>. </p>
+ />, a Shell service controller is preconfigured and registered with the asynchronous provisioning platform (APP). </p>
  <p>This manual describes how to create and use services for Shell scripts on an <ph
  conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"/> marketplace. </p>
  </section>

Development/DocSources/en/ShellIntegrationGuide/Intro/c_Scenarios.xml

@@ -7,7 +7,7 @@
  <conbody>
  <section>
  <p>The <ph conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"
- /> AWS integration supports the following usage scenarios: </p>
+ /> Shell integration supports the following usage scenarios: </p>
  <ul compact="no">
  <li><b>Executing a Script for provisioning</b>: When a customer subscribes to a corresponding service on an <ph
  conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"

Development/DocSources/en/ShellIntegrationGuide/Services/c_ConfigureStatusPanel.xml

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "concept.dtd" [<!ENTITY % entities PUBLIC '-//XDOC//ENTITIES//FujitsuUserDoc' 'entities.dtd'>
+]>
+<!-- Copyright FUJITSU ENABLING SOFTWARE TECHNOLOGY GMBH 2018 -->
+<concept id="concept_1BCF5C425D7D4627AB1C66A085CF6E11"
+ xml:lang="en-us">
+ <title>Configuring the Status Information Page</title>
+ <conbody>
+ <section>For checking the status of the results of a provisioning script execution, you need to define a custom tab for the subscription details: <p>
+ <ol>
+ <li>Make sure that a script for checking the status of provisioned instances is available. ??? Where is such a script? ###</li>
+ <li>Login to the marketplace and select a subscription to a service defined for Shell execution. </li>
+ <li>Under <b>My Subscriptions</b>, you now see, aside the <b>Details</b> tab, the <b>Status</b> tab. </li>
+ </ol>
+ </p>When creating the marketable service for the Shell script execution, specify the <b>URL of a custom tab</b> for : <p>This URL may point to a Web page or Web application the content of which will be retrieved and shown on the custom tab. Particularly users of IaaS services may be interested in additional details on the service and the operation of the service they subscribed to. Using a custom tab, you can provide the information needed for accessing provisioned instances, such as IP addresses, network information, or user credentials.</p>. In this way, you can add a tab to the <b>Details</b> view for subscriptions on the marketplace. <p
+ id="cfg"
+ >A technology provider can define service parameters in the technical service definition. If such a parameter has the same ID as a controller configuration setting stored in the APP database, it overrules the configuration setting in the database when the marketable service based on such a technical service is subscribed to. By default the values in the controller configuration settings are used. Refer to the <i>Technology Provider's Guide</i> for details on defining technical services. </p><p
+ id="cfg2"
+ >In addition, a supplier can define custom attributes for subscriptions and for customers. If such an attribute has the same ID as a controller configuration setting stored in the APP database as well as a corresponding technical service parameter, it overrules the technical service parameter as well as the configuration setting in the database when the marketable service based on such a technical service is subscribed to.</p><p
+ id="cfg3">The controller configuration settings are evaluated as follows: </p><p id="cfg4">
+ <ol>
+ <li>Configuration setting as stored in the APP database. </li>
+ <li>Technical service parameter. If defined, it overrules 1. </li>
+ <li>Custom attribute for customer. If defined, it overrules 1. and 2.</li>
+ <li>Custom attribute for subscription. If defined, it overrules 1. and 2. and 3. </li>
+ </ol>
+ </p><p><b>To update the controller settings in the APP database:</b></p><p>
+ <ol compact="no">
+ <li>Invoke the instance status interface of APP for the Shell service controller of the application by opening it's URL in a Web browser. <p>The access URL has the following format: </p><p><codeph>https://&lt;hostname.fqdn&gt;:&lt;port&gt;/oscm-app-shell</codeph></p><p><codeph>&lt;hostname.fqdn&gt;</codeph> is the name and the fully qualified domain name of the machine where the <codeph>oscm-app</codeph> container has been deployed, <codeph>&lt;port&gt;</codeph> is the port to address the machine (default: <codeph>8881</codeph>), <codeph>oscm-app-shell</codeph> is the default context root of the service controller and cannot be changed. </p></li>
+ <li>Log in with the ID and password of the user specified in the configuration settings for the Shell service controller by the platform operator in the <codeph>BSS_USER_ID</codeph> and <codeph>BSS_USER_PWD</codeph> configuration settings, or as another technology manager registered for the same organization.</li>
+ <li>The following settings can be changed:<p>
+ <ul>
+ <li><b>User ID</b>: The identifier of the user responsible for the Shell service controller.</li>
+ <li><b>User Key</b>: The user key for accessing <ph
+ conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"
+ />. You receive this key with the confirmation email for your user account. The user must have the technology manager role in <ph
+ conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"
+ /> and belong to the technology provider organization responsible for the service controller. <p>It is recommended that the user account is used only for carrying out actions on behalf of the service controller in <ph
+ conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"
+ />.</p></li>
+ <li><b>Password</b>: The password of the user for accessing <ph
+ conref="../../Shared/Product_Name.xml#ProductNameTopic/Product_Abbr"/>.</li>
+ </ul>
+ </p></li>
+ <li>Save the settings.</li>
+ </ol>
+ </p></section>
+ </conbody>
+</concept>