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

	To access the deployment wizard, open the Administration. Your user must have the following profiles: administration_user xuml_container_admin
	Use icon in the navigation bar to open the deployment wizard.
	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 xUML service. For detailed information how to handle containerized xUML services after successfull deployment, refer to one of the following pages (depending on your setup): Controlling Containerized xUML Services (Docker) Controlling Containerized xUML Services (Kubernetes)

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.

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

	In step 2, you can adapt the image options. Name and Version are mandatory and cannot be empty.
	The image options are: Name: By default, the name of the rep.file is used. You can adapt it. Only . (dot) and - (minus) are allowed as special characters and you cannot start or end the name with them. Version: By default, version number 1.0 is displayed. You can adapt it. Runtime: Be default, 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 use.
	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.
	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

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

It is divided into several sections:

General

In this section, you can find the following options:

Hostname: Shows the name of the host which corresponds to the container name (see step 2).
Container 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 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)	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.
on-failure	Restarts the container everytime if it exists due to an error.
none	Container is not automatically restarted.

API Management

In this section, 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.

Custom Labels

In this section, you can mark the service with additional short information. After deployment, the labels will be visible in the service details.

Icon	Description
	Click this icon to add a new custom label.
	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.
	Hover over this icon to display further information about the usage of custom labels.

Step 4: Summary

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

Three sections are summarizing the information provided:

Package Upload
Container Image
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 Close to close the deployment wizard.
Use button Service Details to open the deployed service in the Administration.

For detailed information how to handle containerized xUML services after successfull deployment, refer to one of the following pages (depending on your setup):

On this Page:

Related Pages:

Page tree

Working With the Deployment Wizard