With the deployment wizard, Scheer PAS provides a tool to deploy xUML services into a as Docker container and Kubernetes workload. All you need is the repository (.rep file) of the service.

To access the deployment wizard, open the Administration.

Info

Your user must have the following profiles:

administration_user

needs the profile xuml_container_admin to use the deployment wizard and to manage xUML services in the Administration.

Use icon in the navigation bar to open the deployment wizard.

Image Modified

The wizard opens in a pop-up window.

As soon as you have selected the .rep file of the service, the wizard guides you through the necessary steps to create a containerized an xUML service.

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	tip_details_on_containerized_services
PageWithExcerpt	INTERNAL:_admin_portal_excerpts

Step 1: Package Upload

First, select the .rep file of the service you want to deploy. You can use the button Coose File to search your computer or drag and drop the file within the framed box.

The name of your service is then displayed below the button.

Image Removed

Use the select field Namespace to choose the profile where the .rep file is deposited temporarily. The file will be deleted when the wizard is closed.

A selection list is displayed, if you have more than one namespace assigned to your user

.

If only one namespace is assigned to your user, the wizard will automatically use this namespace.

If no namespace is assigned to your user, you will get a notification.

Click Next to continue.

Step 2: Image Options
Anchor
image_options
image_options

Only . (dot) and - (minus) are allowed as special characters and you cannot start or end the name with them

(see below for naming restrictions).
Version: By default, version number 1.0 is displayed. You can adapt it.
Runtime: Be defaultOnly available if your system contains several Runtime versions. If so, the latest version of the Runtime is used. If several Runtime versions are available on your system, you can use the selection list to choose the version you want to useselected by default. Use the drop-down list to change the version.

In step 2, you can adapt the image options. All displayed fields are mandatory.

Info
Name and Version are mandatory and cannot be emptyThe selection list to choose a Runtime version is only displayed, if several Runtime versions are available on your system.

The image options are:

Name: By default, the name of the rep.file is used. You can adapt it .

Info

Anchor

	naming_restrictions
	naming_restrictions

Image Added

Various input restrictions apply to field Name. If you enter invalid characters, corresponding validation notes are displayed.

Info

title	Input Restrictions

The following restrictions apply: The name...

... must be between 1 and 63 characters long.
... must not contain any special characters except - (minus).
... must not start or end with - (minus).
... must not start with a number.

An image must have a unique designation.

You will get a warning message if an image with the same name and version already exists.

In that case, you must at least change name or version of the image.

Image Modified

When all mandatory fields have been filled, you have two options:

Click Next to adapt the deployment options. This third step of the deployment wizard is optional.
Click Summary to check the deployment data and start the build process.

Step 3: Deployment Options
Anchor
deployment_options
deployment_options

Restarts the container always if it stops, except when the container is stopped (manually or otherwise). It is then not restarted even after the Docker daemon restarts

.

always

Restarts the container always if it stops.

- If the

container is stopped manually, it is restarted only...

...when the Docker daemon restarts.
...when the container is manually restarted.

API Management

In thissection, you can find the options related to the API Management component:

Organization: Endpoints are securely registered in default organizations in Scheer PAS API Management. Optionally, you can override the default organization where REST/SOAP services should be registered. The selection list shows all organizations your user is a member of.

Image Modified

Step 3 is optional and allows you to adapt the deployment options.

It is divided into several different sections:

General API Management
Custom Labels

General

In thissection, you can find the following options:

Hostname: Shows the name of the host which .
In a Docker setup, it corresponds to the container name (see step 2).
In a Kubernetes setup, it corresponds to the workload name (see step 2).
Container Service Name: By default, the image name is displayed. If the name is already in use, the container will be overwritten. You can also change the name. The container service name is the name that will be displayed in the service list.Restart Policy: Use the selection list to choose the restart policy for your container.

Restart Options

Description

unless-stopped (default)

on-failure

Restarts the container everytime if it exists due to an error.

none

Container is not automatically restarted.

Image Removed

- name is already in use, the container will be overwritten.

Image Added

Custom (Container) Labels

Use this option to add technical labels for the container. The labels are added to the container and are also displayed later

Image Removed

Custom Labels

In thissection, you can mark the service with additional short information. After deployment, the labels will be visible

in the service details.

Icon	Description
Image Modified	Click

this icon

Plus to add a new custom label.
Image Modified	If you want to delete one or more labels, tick the corresponding checkbox(es) in front of the label you want to delete. Then click

the trash can icon

Delete.
Image Modified	Hover over

this icon

Image Added to display further information about the usage of custom labels.

Image Added

After deployment, the labels are also visible in section Deployment in the service details.

Step 4: Summary
Anchor
summary
summary

In the last step, you can check all deployment-related information again.

Three sections are summarizing the information provided:

Package Upload
Container Image Options
Deployment Options

If you want to adapt some of your inputs, use the Back button or click on one of the steps in the navigation to access it directly.

Click Build & Deploy to start the deployment process.

The wizard starts the deployment and keeps you updated about the running deployment steps.

This information is read-only, you cannot intervene in the process now.

You can take action again when the deployment has been completed.

Use button Click Close to close the deployment wizard.
Use button Click Service Details to open the deployed service in the Administration.

Multiexcerpt include

SpaceWithExcerpt	INTERNAL
MultiExcerptName	tip_details_on_containerized_services
PageWithExcerpt	INTERNAL:_admin_portal_excerpts

Panel

Otp

Floating	false
maxHLevel	2

title	On this Page:

Table of Contents

rp

Panel

title	Related Pages:

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Step 1: Package Upload

Step 2: Image Options
Anchor
image_options
image_options