Creating an action

You can create a new action in a domain.

Procedure

  1. Log in to the Self-service user interface as a Service Designer.
  2. In the navigation menu, click CONFIGURATION > Actions Registry.
  3. Click Create Action in the Actions menu. The Create Action window is displayed.
  4. Enter a name for the action.
  5. Select an icon and a process for the action.
  6. Optional: Enter a description for the action.
  7. Select the type of resource the action applies to and include the tags you want the action to apply to.
    You must specify which instance the action applies to. Based on the selection of the type, choose from a list of tags that the instance might have. The action only appears on instances having the type and tag. The field Specify the item selection criteria allows you to specify whether the action is able to:
    • Create an instance. Select createInstanceAction.
    • Modify only a single instance. Select singleInstanceAction.
    • Modify multiple instances. Choose multiInstanceAction.

    Tags are working as an extra filter mechanism for actions to be performed on selected instances. As an example take the Start action for virtual servers. It has the tag shutoff. This means that the Start action is only be available for virtual servers (openstackvms) that are stopped. Those tags can be set during action creation or modification in the Actions Registry depending on the selected instance type (for example, openstackvms). The following tags are provided by IBM® Cloud Orchestrator through their instance providers:

    For virtual machines (openstackvms):
    shutoff: stopped virtual machine.
    active: running virtual machine.
    nova: virtual machine that is created directly in OpenStack.
    heat: virtual machine that is created through a Heat template.
    keynamedefined: virtual machines having an SSH key defined for access.
    For Stacks (heat):
    createcomplete: Heat stack instances that are created and are ready to use.
    createfailed: Heat stack instances that failed to be created.
    For Volumes (volumes):
    available: volumes ready for use.
    cinder: all volumes that are created as OpenStack Cinder volumes.
    in-use: volumes that are already occupied or used by virtual machines.
    formatted: volumes that are formatted.
    For Domains (domain):
    disabled: domains not ready for use (disabled).
    enabled: domains that are enabled for use.
    For Projects (project):
    disabled: projects not ready for use (disabled).
    enabled: projects that are enabled for use.
    For Users (user):
    disabled: users not ready for use (disabled).
    enabled: users that are enabled for use.
    For Offerings (offering):
    offering: a resource that is of type offering.
    For Action Registry (action):
    multiInstanceAction: actions performed on multiple instances.
    singleInstanceAction: actions performed on a single instance.
    For Categories (categories):
    Not applicable.
  8. Select the application to filter the processes by that application. Once the process has been found, select the user interface from the list of available human services for the selected process. Then, configure the access control. The Domain Administrator and the Service Designer are allowed to modify the offering.
  9. Click Create.

Results

A message appears indicating that the action is created successfully.