Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WADMINPAS and version 23.1

With the deployment wizard, Scheer PAS provides a tool to deploy xUML services into a 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.

    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
    SpaceWithExcerptINTERNAL
    MultiExcerptNametip_details_on_containerized_services
    PageWithExcerptINTERNAL:_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.

    Click Next to continue.

    Step 2: Image Options 
    Anchor
    image_options
    image_options

    In step 2, you can adapt the image options.

    Info

    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.
    Info

    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 
    Anchor
    deployment_options
    deployment_options

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

    It is divided into different sections:

    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).
    • 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 service name is the name that will be displayed in the service list.
      • If the name is already in use, the container will be overwritten.

    Custom Labels

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

    IconDescription
    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 
    Anchor
    summary
    summary

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

    Three sections are summarizing the information provided:

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

    Multiexcerpt include
    SpaceWithExcerptINTERNAL
    MultiExcerptNametip_details_on_containerized_services
    PageWithExcerptINTERNAL:_admin_portal_excerpts