Deploying an Internal Application

This guide explains how to manage packages that are not part of the base operating system repositories and how to deploy an internally packaged application. orcharhino manages arbitrary .deb and .rpm packages the same way it handles any upstream repositories. This example deploys Prosody, an open source XMPP server, to a host running Ubuntu 20.04.

For a better understanding of provisioning hosts using orcharhino, see our glossary for terminology and key terms. Key terms include deployment, compute resource, provisioning template, and virtualization.

Structure

This usage guide is structured into five sections:

  1. Installing orcharhino references the orcharhino installation guide and is the base for using orcharhino. Selecting Ubuntu 20.04 during the main installation allows you to skip parts of this guide.

  2. Preparing infrastructure incorporates your orcharhino server into your existing infrastructure. The first two steps are only necessary when starting with orcharhino.

  3. Preparing the operating system entry bundles all necessary information to set up your orcharhino to manage hosts running Ubuntu 20.04. You can skip this step if your orcharhino is already configured to deploy hosts running Ubuntu 20.04.

  4. Managing content demonstrates how to set up your orcharhino to synchronize and distribute content. You can synchronize and distribute any internal software packaged as .deb and .rpm package.

    Synchronized repositories are organized in products. Use content views which bundle and version lists of repositories to make the correct content available to your content hosts. This guide chooses Prosody as an example for custom content.

  5. Provisioning a host demonstrates how to automatically deploy hosts based on host groups. Host groups are blueprints bundling provisioning and configuration details to deploy hosts with the click of a button.

    This usage guide chooses Ansible to configure hosts. You can attach Ansible roles to individual hosts or group of hosts to limit your configuration efforts.

Goal

Following this usage guide, you can deploy any .deb package to managed hosts using orcharhino. If your organization is using an internal artifact store such as Gitlab, JFrog Artifactory, nexus repository oss, Pulp, or just plain repositories on an HTTP server, orcharhino is just the right tool to fetch content and distribute it to managed hosts in an automated and versioned way. orcharhino fetches software packages from any valid repository with content for CentOS, Debian, Oracle Linux, Red Hat Enterprise Linux, SUSE Linux Enterprise Server, and Ubuntu. Once synchronized to orcharhino, you can deploy and configure hosts to run arbitrary .deb and .rpm packages.

Use Cases

You can use orcharhino to test internally developed software. Once software gets built and pushed to an artifact store, you can either automatically trigger a sync using the orcharhino API or Hammer CLI; or wait until a sync plan runs to fetch content to orcharhino. Once synchronized, you can make content available to managed hosts, for example nightly builds to your Development environment.

Pushing content to quality assurance is as simple as promoting a content view from Development to Test. Once the quality assurance team declares software stable, it can simply be released to Production or in turn be fetched by your customers.

If you are running internally written software in production, simply promote versioned and tested content from the Test to the Production lifecycle environment. All managed hosts attached to this content can then be upgraded using a job template. Refer to deploying multiple versions on how to deploy multiple versions of content to hosts in different lifecycles.

The same applies if you depend on external software to be run in your data center. You can use orcharhino to version this content, too.

Installing orcharhino

Follow the installation guide to install orcharhino:

This guide assumes you have orcharhino manage DHCP, DNS, and TFTP in its network.

Select Ubuntu 20.04 on the fourth step of the main installation to skip setting up a partition table, provisioning templates, and the orcharhino Client for Ubuntu 20.04.

Preparing Infrastructure

Integrate orcharhino with your existing infrastructure.

Creating a Subnet

Set up a subnet.

This procedure assumes orcharhino manages DHCP and DNS for its network.

Procedure
  1. Navigate to Infrastructure > Subnets.

  2. Click Create Subnet.

  3. Enter all relevant details of the subnet orcharhino manages. Ensure to select your orcharhino as remote execution proxy and its domain on the corresponding tabs.

  4. Click Submit to save your subnet.

Setting the DNS Proxy for a Domain

Your orcharhino installation automatically sets up a domain based on the hostname of your orcharhino.

Procedure
  1. Navigate to Infrastructure > Domains.

  2. Select the existing domain.

  3. Enter your DNS proxy, which is either your orcharhino server or any attached orcharhino proxy.

  4. Click Submit to save your changes.

Creating a Compute Profile

Set up a compute profile.

Procedure
  1. Navigate to Infrastructure > Compute Profiles.

  2. Click Create Compute Profile.

  3. Enter a Name for the compute profile.

  4. Click Submit to save your compute profile.

  5. Select your previously attached compute resource provider.

  6. Define various settings for new virtual machines depending on the compute resource provider.

Preparing the Operating System Entry

Set up orcharhino to provision hosts running Ubuntu 20.04.

Preparing the Installation Medium

Extract the installation media for Ubuntu 20.04 on your orcharhino to perform offline installations.

Instead of extracting the installation media manually, you can synchronize a file repository from ATIX which you can use as local installation media.

Procedure
  1. Connect to your orcharhino using SSH:

    # ssh root@orcharhino.example.com
  2. Download the Ubuntu 20.04 server legacy installation media from ubuntu.com using wget:

    # cd /tmp
    # wget http://cdimage.ubuntu.com/ubuntu-legacy-server/releases/20.04/release/ubuntu-20.04.1-legacy-server-amd64.iso
  3. Verify the integrity and authenticity of the .iso image using GPG public keys:

    # gpg --keyserver keys.gnupg.net --recv-key 3B4FE6ACC0B21F32 D94AA3F0EFE21092 871920D1991BC93C
    # wget http://cdimage.ubuntu.com/ubuntu-legacy-server/releases/20.04/release/SHA256SUMS
    # wget http://cdimage.ubuntu.com/ubuntu-legacy-server/releases/20.04/release/SHA256SUMS.gpg
    # gpg --verify SHA256SUMS.gpg SHA256SUMS
    # echo 'f11bda2f2caed8f420802b59f382c25160b114ccc665dbac9c5046e7fceaced2 *ubuntu-20.04.1-legacy-server-amd64.iso' | sha256sum --check
  4. Mount the .iso image:

    # mount ubuntu-20.04.1-legacy-server-amd64.iso /mnt
  5. Copy the content of the mounted installation media to the pub directory:

    # mkdir -p /var/www/html/pub/installation_media/ubuntu_20_04
    # cp -a /mnt/* /var/www/html/pub/installation_media/ubuntu_20_04/
  6. Create the required directory structure:

    # cd /var/www/html/pub/installation_media/ubuntu_20_04
    # mkdir -p dists/focal/main/installer-amd64/current/legacy-images/
    # cd dists/focal/main/installer-amd64/current/legacy-images/
    # ln -s ../../../../../../install/netboot
  7. Unmount and delete the .iso image:

    # cd
    # umount /mnt
    # rm -rf /tmp/ubuntu-20.04.1-legacy-server-amd64.iso

Use the path to the local installation media files when creating an installation medium, for example http://orcharhino.example.com/pub/installation_media/ubuntu_20_04/. This allows for offline installations of hosts running Ubuntu 20.04.

Creating the Operating System Entry

Create an installation medium and operating system for Ubuntu 20.04.

You can use a script to add operating system entries to your orcharhino Server.

On your orcharhino Server, uncomment the operating systems and orcharhino Client that you want to add in /etc/orcharhino-ansible/or_operating_systems_vars.yaml, replace the default organization and location names, and run /opt/orcharhino/automation/play_operating_systems.sh. For more information, see /usr/share/orcharhino-ansible/README.md on your orcharhino Server.

Procedure
  1. Navigate to Hosts > Installation Media and click Create Medium.

    Creating an installation medium for Ubuntu 20.04
    • The Name field (1) identifies the installation media for Ubuntu 20.04. We recommend adding local to the name as the path of the extracted .iso image points to the orcharhino. Use a locally available installation medium to perform offline installations.

    • The Path field (2) defines the path to the extracted .iso image. The content of /var/www/html/pub/ is publicly available on http://orcharhino.example.com/pub/. If you extract the .iso image to /var/www/html/pub/installation_media/ubuntu_20_04/, the path is http://orcharhino.example.com/pub/installation_media/ubuntu_20_04/.

      ATIX provides file repositories for installation media. Once synchronized, you can perform offline host deployments using a local installation media. See ATIX Service Portal for the upstream URL.

      ATIX provides the following installation media as file repository:

      • Debian 9, 10, and 11

      • Ubuntu 18.04

      • Ubuntu 20.04

    • Set the Operating System Family drop down menu (3) to Debian for all Debian and Ubuntu systems.

    • Set a location and organization context (4) for the installation media.

    • Click the Submit button (5) to save the installation media entry for Ubuntu 20.04.

  2. Navigate to Hosts > Operating Systems and click Create Operating System.

    Creating an operating system for Ubuntu 20.04
    • Set the Name (1) of the operating system. Choose a name as reported by Ansible, Puppet, or Salt as fact.

    • Set the Major Version (2) of Ubuntu, for example 20.04.

    • Omit the Minor Version (3) for Ubuntu.

    • Optional: Add an arbitrary Description (4).

    • Assign Ubuntu 20.04 to the Family (5) to the Debian family.

    • Set the Release Name (6) for Ubuntu, for example focal for Ubuntu 20.04.

    • Set the Root Password Hash (7) to SHA256 for Ubuntu.

    • Assign the Architectures (8) to Ubuntu.

    • The other tabs (9) require associations to the newly created operating system. Select a partition table, an installation media, templates, and optionally parameters.

      On a basic orcharhino installation, you are not able to select any partition tables and templates when creating the operating system. Instead, save the Ubuntu 20.04 operating system entry by clicking the Submit button as shown above and navigate to Hosts > Partition Tables and Hosts > Provisioning Templates to associate the default templates with the operating system. Return to the operating system and select those templates using the drop down menu.

    • Click the Submit button (10) to save the operating system entry.

Using Custom Templates

Your orcharhino installation comes with all required templates. We do not recommend to manually create new or edit locked templates. Custom templates and unlocked templates do not receive any updates during an orcharhino upgrade.

Use the clone function to customize templates. Note, that cloned or manually created templates are not updated during an orcharhino upgrade.

In case you know what you are doing, and template editing is desirable, the management UI provides extensive tools to do so, including inbuilt documentation on template syntax at https://orcharhino.example.com/templates_doc.

Creating a Partition Table

Create a partition table for Ubuntu 20.04.

Procedure
  1. Navigate to Hosts > Partition Tables.

  2. Click Create Partition Table.

  3. Enter a Name for your partition table. We recommend adding Preseed to the name of the partition table for Debian and Ubuntu to differentiate with AutoYaST for SUSE Linux Enterprise Linux and Kickstart for CentOS, Oracle Linux, and Red Hat Enterprise Linux.

  4. Optional: Check the Default checkbox to assign the partition table to all organization and location contexts.

  5. Select Debian from the Operating System Family list.

  6. In the Editor field, enter the Preseed Default partition table from your orcharhino:

    # cat /usr/share/foreman/app/views/unattended/partition_tables_templates/preseed_default.erb
  7. Ensure the partition table is assigned to the correct organization and location context.

  8. Click Submit to save your partition table.

Creating a Finish Template

Create a finish template for Ubuntu 20.04.

Procedure
  1. Navigate to Hosts > Provisioning Templates.

  2. Click Create Template.

  3. Enter a Name for the provisioning template. We recommend adding Preseed to the name of the provisioning template for Debian and Ubuntu to differentiate with AutoYaST for SUSE Linux Enterprise Linux and Kickstart for CentOS, Oracle Linux, and Red Hat Enterprise Linux.

  4. Optional: Check the Default checkbox to assign the provisioning template to all organization and location contexts.

  5. In the Editor field, enter the Preseed Default Finish provisioning template from your orcharhino:

    # cat /usr/share/foreman/app/views/unattended/provisioning_templates/finish/preseed_default_finish.erb
  6. Click the Type tab.

  7. Select Finish template from the Type list.

  8. On the Association tab, select Ubuntu 20.04 in the Applicable Operating Systems field.

  9. Ensure the provisioning template is assigned to the correct organization and location context.

  10. Click Submit to save your finish template.

Creating a Provisioning Template

Create a provisioning template for Ubuntu 20.04.

Procedure
  1. Navigate to Hosts > Provisioning Templates.

  2. Click Create Template.

  3. Enter a Name for the provisioning template. We recommend adding Preseed to the name of the partition table for Debian and Ubuntu to differentiate with AutoYaST for SUSE Linux Enterprise Linux and Kickstart for CentOS, Oracle Linux, and Red Hat Enterprise Linux.

  4. Optional: Check the Default checkbox to assign the provisioning template to all organization and location contexts.

  5. In the Editor field, enter the Preseed Default provisioning template from your orcharhino:

    # cat /usr/share/foreman/app/views/unattended/provisioning_templates/provision/preseed_default.erb
  6. Click the Type tab.

  7. Select Provisioning template from the Type list.

  8. On the Association tab, select Ubuntu 20.04 in the Applicable Operating Systems field.

  9. Ensure the provisioning template is assigned to the correct organization and location context.

  10. Click Submit to save your provisioning template.

Creating a PXELinux Template

Create a PXELinux template for Ubuntu 20.04.

Procedure
  1. Navigate to Hosts > Provisioning Templates.

  2. Click Create Template.

  3. Enter a Name for the provisioning template. We recommend adding Preseed to the name of the partition table for Debian and Ubuntu to differentiate with AutoYaST for SUSE Linux Enterprise Linux and Kickstart for CentOS, Oracle Linux, and Red Hat Enterprise Linux.

  4. Optional: Check the Default checkbox to assign the provisioning template to all organization and location contexts.

  5. In the Editor field, enter the Preseed Default PXELinux provisioning template from your orcharhino:

    # cat /usr/share/foreman/app/views/unattended/provisioning_templates/PXELinux/preseed_default_pxelinux.erb
  6. Click the Type tab.

  7. Select PXELinux template from the Type list.

  8. On the Association tab, select Ubuntu 20.04 in the Applicable Operating Systems field.

  9. Ensure the provisioning template is assigned to the correct organization and location context.

  10. Click Submit to save your PXELinux template.

Associating Templates to an Operating System

Associate the previously created partition table and provisioning templates with the Ubuntu 20.04 operating system.

Procedure
  1. Navigate to Hosts > Operating Systems.

  2. Select the Ubuntu 20.04 operating system.

  3. On the Partition Table tab, select your previously created Preseed partition table as Partition Table.

  4. On the Templates tab, select your previously created Preseed Finish template as Finish template, Preseed template as Provisioning Template, and Preseed PXELinux template as PXELinux template.

  5. Click Submit to associate the partition table and provisioning templates with Ubuntu 20.04.

Managing Content

Synchronize content to orcharhino to supply hosts running Ubuntu 20.04.

For a better understanding of orcharhino’s content management, see our glossary for terminology and key terms. Key terms include product, repository, content view, lifecycle environment, and activation key.

Creating Content Credentials

orcharhino uses GPG public keys to verify signatures as a security measure to ensure the authenticity and integrity of remote content sources.

  • Add content credentials for the Ubuntu operating system repositories.

  • Add the GPG public key for the orcharhino Client repository.

  • Add the GPG public key for your custom content repository.

    orcharhino only accepts ascii-armored GPG public keys. You can convert binary GPG public keys using gpg:

    # cd /tmp/
    # wget --quiet https://prosody.im/files/prosody-debian-packages.key
    # gpg --import prosody-debian-packages.key
    # gpg --armor --export 7393D7E674D9DBB5 > prosody.txt

    Add the prosody.txt GPG public key as content credential to orcharhino.

Creating a Sync Plan

Create a sync plan to periodically fetch new packages from synchronized repositories.

Procedure
  1. Navigate to Content > Sync Plans.

  2. Click Create Sync Plan.

  3. Choose a Name, Interval, Start Date, and Start Time for your sync plan.

  4. Click Submit to save your sync plan.

Synchronizing Upstream Repositories

Synchronize the default Ubuntu 20.04 repositories.

Procedure
  1. Create a product called Ubuntu 20.04 OS.

    Navigate to Content > Products and click Create Product.

  2. Create the default Ubuntu 20.04 repositories.

    Navigate to Content > Products and select the Ubuntu 20.04 OS product. Click New Repository and create repositories of type deb:

  3. Use to previously created sync plan to periodically fetch content from the upstream sources.

  4. Add the corresponding GPG public keys as a content credential to verify the authenticity of the meta data of the Ubuntu repositories.

  5. Synchronize the repositories.

    Synchronize all repositories using the Select Action > Sync Now button on the products page.

Check the dependencies of your custom content. This example installs Prosody which has a dependency to mercurial which is only available in universe. This requires at least 150 GiB of free disk space.

Otherwise, it is much faster to only synchronize components main and restricted. This requires at least 60 GiB of free disk space.

Synchronizing orcharhino Client Repositories

Synchronize the orcharhino Client for Ubuntu 20.04.

Refer to adding an orcharhino Client on how to synchronize the orcharhino Client for Ubuntu 20.04. Navigate to the ATIX Service Portal for the upstream URL of the orcharhino Client repository for Ubuntu 20.04. The procedure is analogue to adding upstream Ubuntu repositories.

Synchronizing Custom Content

orcharhino can synchronize any valid APT and Yum repository.

This guide deploys Prosody, a .deb package that is not available in the default Ubuntu 20.04 repositories. Instead, built .deb packages are available on prosody.im.

Procedure
  1. Create a product called Prosody.

    Navigate to Content > Products and click Create Product.

  2. Create a repository.

    Navigate to Content > Products and select the Prosody product. Click New Repository and create a repository of type deb.

  3. Use to previously created sync plan to periodically fetch content from the upstream source.

  4. Add the corresponding GPG public keys as a content credential to verify the authenticity of the meta data of the Prosody repository.

  5. Synchronize the repository.

    Synchronize the repository using the Select Action > Sync Now button on the products page.

CLI Procedure
  1. Connect to your orcharhino using SSH:

    # ssh root@orcharhino.example.com
  2. Create a product.

    # hammer product create \
        --description "Prosody XMPP Server" \
        --name "Prosody" \
        --organization-id 1 \
        --sync-plan-id 2
  3. Create a repository.

    # hammer repository create \
        --content-type "deb" \
        --deb-architectures "amd64" \
        --deb-components "main" \
        --deb-releases "focal" \
        --gpg-key-id 21 \
        --name "hammer_prosody" \
        --organization-id 1 \
        --product-id 5 \
        --publish-via-http true \
        --url "https://packages.prosody.im/debian"
  4. Synchronize the repository.

    # hammer product synchronize \
        --id 5 \
        --organization-id 1

    Use the --async flag to synchronize the not wait until the products has been synchronized. Instead, hammer returns a task id.

Creating Lifecycle Environments

Lifecycle environments are part of orcharhino’s content management. They restrict access to content and allow you to run different versions of the same software. Use lifecycle environments to create versions of software packages and errata.

Procedure
  1. Navigate to Content > Lifecycle Environments.

  2. Click Create Environment Path.

  3. Click Add New Environment to create environments inside your path. Ensure to create a sequence by setting the Prior Environment accordingly.

You can use one lifecycle path with three sequential lifecycle environments: Development, Testing, and Production.

By default, all content is automatically part of the Library lifecycle environment.

Creating Content Views

A content view is a named list of repositories. Publishing a content view freezes the current state. Synchronizing content into a repository that is part of a content view does not update an already published content view.

Create two content views to separate the operating system plus client and your custom content.

Procedure
  1. Navigate to Content > Content Views.

  2. Click Create New View.

  3. Enter a Name and click Save.

  4. On the Deb Content tab, select Repositories.

  5. On the Add tab, select the three previously created repositories for Ubuntu 20.04 and the orcharhino Client repository.

  6. Click Add Repositories to save your changes.

  7. Click on Publish New Version and optionally add a description.

  8. Click Save to publish a new version of the content view.

Rerun this procedure for your custom content repositories.

Creating a Composite Content View

A composite content view is a named list of content views.

Creating a composite content view allows you to combine two versioned content views. You can update your operating system and client at a different pace than your internal application.

Procedure
  1. Navigate to Content > Content Views.

  2. Click Create Content View.

  3. Enter a Name, preferably containing either Composite or CCV (short for Composite Content View), and select the Composite View checkbox.

  4. Click Save to save your composite content view.

  5. On the Add tab, select both previously created content views and click Add Content Views.

    You can optionally add further content views. For example, if you want to configure your hosts using Puppet, add a content view containing the necessary repositories for the Puppet agent.

  6. Click Publish New Version and optionally add a description.

  7. Click Save to publish your composite content view.

  8. Promote the composite content view to the lifecycle environment of your choice by clicking the Promote button.

  9. Select one of the previously created lifecycle environments and click Save to promote your composite content view.

Creating an Activation Key

Create an activation key to define the content available to hosts. Activation keys are used by the subscription-manager to register hosts with orcharhino and consist of three parts: a lifecycle environment, a content view, and multiple subscriptions, which generally correspond to products.

Procedure
  1. Navigate to Content > Activation Keys.

  2. Click Create Activation Key.

  3. Choose a Name, Environment, and Content View.

  4. Click Save to save your activation key.

  5. On the Subscriptions tab, select the Add tab and assign the necessary subscriptions, for example Ubuntu 20.04 and Prosody.

Provisioning a Host

After configuring orcharhino and synchronising all necessary content, create a host group to simplify deploying hosts running your custom application.

Creating a Host Group

Host groups bundle provisioning and configuration settings.

Procedure
  1. Navigate to Configure > Host Groups.

  2. Click Create Host Group.

  3. On the Host Group tab, enter a Name, for example Ubuntu 20.04, and assign the previously created Lifecycle Environment, Content View, Content Source, Deploy on, and Compute Profile.

  4. On the Network tab, assign the Domain and Subnet.

  5. On the Operating System tab, assign the Architecture, Operating System, Media, Partition Table, PXE-Loader, and enter a default root password.

  6. On the Locations tab, assign a location.

  7. On the Organizations tab, assign an organization.

  8. On the Activation Keys tab, assign the previously created activation key.

  9. Click Submit to save your host group.

You can now comfortably deploy hosts running Ubuntu 20.04 using the Ubuntu 20.04 host group.

Installing the Ansible Plugin

Install the Ansible plugin for configuration management.

Procedure
  1. Connect to your orcharhino using SSH.

  2. Install the Ansible plugin:

    # orcharhino-installer --enable-foreman-plugin-ansible --enable-foreman-proxy-plugin-ansible

Using Ansible to Configure Hosts

Use an Ansible role to install your custom application.

github.com/ATIX-AG/ansible-role-prosody is based on an Ansible role by systemli. Based on the master branch, the atix-master branch removes the dependency to the systemli.apt_repositories Ansible role because orcharhino provides the necessary software packages. It also adds Ubuntu 20.04 to the list of supported systems.

Procedure
  1. Place your Ansible role on orcharhino.

    # cd /etc/ansible/roles/
    # git clone https://github.com/ATIX-AG/ansible-role-prosody.git
    # cd ansible-role-prosody
    # git checkout origin/atix-master

    Alternatively, you can transfer the Ansible role to your orcharhino using scp or download Ansible roles and collections directly from Ansible Galaxy:

    # scp /path/to/local_role/ root@orcharhino.example.com:/etc/ansible/roles/
    # ansible-galaxy install --roles-path /etc/ansible/roles/ Namespace.Ansible_Role
    # ansible-galaxy collection install --collections-path /usr/share/ansible/collections/ansible_collections/ community.general
  2. Import your Ansible role into orcharhino.

    1. Navigate to Configure > Ansible Roles.

    2. Click Import from FQDN to open a drop down menu with a list of your orcharhino and any attached orcharhino proxies. Select the machine on which you previously transferred the Ansible role to.

    3. Select your Ansible role and click Update to import it to orcharhino.

  3. Import Ansible variables into orcharhino.

    1. Navigate to Configure > Ansible Roles.

    2. Click Variables on your previously imported Ansible role.

    3. Click Import from FQDN to open a drop down menu with a list of your orcharhino and any attached orcharhino proxies. Select the machine on which you previously transferred the Ansible role to.

    4. Select all variables and click Update.

  4. Assign your Ansible role to a host group.

    1. Navigate to Configure > Host Groups.

    2. Select a host group.

    3. Add the imported Ansible role on the Ansible roles tab.

    4. Click Submit to save your changes.

Deploying a Host

Use the previously created host group to deploy one or more hosts.

Procedure
  1. Navigate to Hosts > Create Host.

  2. Select the previously created Host Group.

  3. Click Submit to deploy a host.

orcharhino now starts provisioning and configuration your host. Here, configuration also includes installing and configuring your custom software using the previously imported Ansible role.

Testing Your Application

Test your deployed application in whichever way you see fit.

This guide is not meant to be a how to run your own XMPP server tutorial. Prosody is just an example for packaged software that is not part of the default Ubuntu 20.04 repositories.

Use an XMPP client to connect to your XMPP server.

Procedure
  1. Connect to your host using SSH:

    # ssh root@my-host.example.com
  2. Create an account in Prosody:

    # prosodyctl adduser alice@localhost

    Enter Alice’s password twice.

  3. Connect to your client using SSH:

    # ssh root@my-client.example.com

    Ensure your client can connect to your deployed host.

  4. Connect to your XMPP server using an XMPP client, for example Profanity:

    # profanity

    Run /connect alice@localhost server 12.34.56.78 tls trust to connect to your XMPP server. Replace the IP of your managed host running Prosody accordingly.

Updating Your Application

Update your application on one or multiple hosts.

Procedure
  1. Synchronize your content to orcharhino.

    Set up a sync plan to synchronize content on a regular basis or start a manual sync.

  2. Publish your composite content view.

    1. Navigate to Content > Content Views.

    2. Select your composite content view.

    3. Click Publish New Version.

  3. Promote your composite content view.

    1. Navigate to Content > Content Views.

    2. Select your composite content view.

    3. Click Promote to promote your composite content view to a new lifecycle environment.

  4. Rerun the Ansible role.

    1. Navigate to Hosts > All Hosts.

    2. Select one or multiple hosts.

    3. Click Run all Ansible roles from the actions drop down menu.

      Alternatively, you can update the software package using remote execution.

Deploying Multiple Versions

orcharhino’s content management capabilities allow you to serve content to multiple hosts in different lifecycles. Perform the following steps to deploy a host with different content.

Procedure
  1. Synchronize your content to orcharhino.

    Set up a sync plan to synchronize content on a regular basis or start a manual sync.

  2. Publish your composite content view.

    1. Navigate to Content > Content Views.

    2. Select your composite content view.

    3. Click Publish New Version.

  3. Promote your composite content view.

    1. Navigate to Content > Content Views.

    2. Select your composite content view.

    3. Click Promote to promote your composite content view to a new lifecycle environment.

  4. Create an activation key for each of your used lifecycle environments.

    1. Navigate to Content > Activation Keys.

    2. Click Create Activation Key.

    3. Enter a name and select a lifecycle environment and content view.

    4. On the Subscriptions tab, add the previously created repositories.

  5. Deploy a host.

    1. Navigate to Hosts > Create Host.

    2. Select your host group.

    3. Select a different lifecycle environment.

      Alternatively, you can create a host group with a different lifecycle environment.

      Use nested host groups to differentiate between your lifecycle environments:

      1. Create a host group with lifecycle environment Library.

      2. Navigate to Configure > Host Groups.

      3. Click Nest on your previously created host group.

        1. Enter a name, for example Ubuntu 20.04 Prosody Development.

        2. Specify the Lifecycle Environment, Content View, and Activation Key accordingly.

      Once you have four host groups in total, you can serve managed hosts all currently available content using the Library lifecycle environment, as well as synchronized content in the three stages Development, Testing, and Production. Managing your content with orcharhino helps you deploy different versions of your internal application purely based on a host group. This means you can define the lifecycle environment of a managed host with a single setting.