Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Complete user-facing documentation

Table of Contents

Prerequisites

Warning

Always review Items' documentation to learn about their specific prerequisites and dependencies.

For hands-on users wishing to deploy, make sure you have covered the basics:

  • Access Credentials: Ensure that you have any of the keys, secrets or tokens required by the Item
  • Local Prerequisites: Install any tooling needed for deployment:

Item Deployment Best-Practices

There are many good practices you can follow to save yourself or your team the effort of dealing with avoidable security risks or downtime (see Best practices for tenancy management). When it comes to Item deployment specifically, we recommend to at least ensure the following:

  • Versioning: Always pin Item versions, for stability, to reduce the blast radius of bugs mistakenly introduce as part of new Item releases and facilitate rollbacks.
  • Secret management: Use environment variables or secret managers to temporarily make credentials available for deployment tools.

Deployment Guides

A first deployment could include the following steps:

  1. Request OpenStack application credentials if you have none, and added them to your working environment (see How to request Openstack Application Credentials and the "Getting Started" section of this page for more information ).
  2. Create your ssh keypair and import the public key into OpenStack if you have note done so already (see the "Import SSH key" section of this page for details)

From this point onwards, the deployment steps are mostly dependent on the Item Technology. For detailed guidance per specific technology, you can get started with these example:

Deploying an Ansible Playbook

Info

Page under construction

Find out

Items in the EWC Community Hub can be built using a wide range of automation and development technologies, including:

  • Ansible Playbooks – for configuration management and orchestration

  • Terraform Modules – for infrastructure provisioning

  • Helm Charts – for Kubernetes application deployments

  • Jupyter Notebooks – for interactive data analysis and workflows

  • Combinations – where multiple technologies are used together

Not all items are deployable.

  • Deployable items are those that can be executed to provision, configure, or deploy a resource or application directly (e.g., Ansible, Terraform, Helm).

  • Non-deployable items may serve as supporting tools, examples, or libraries that you integrate into your own workflows.

To help you get started, we’ve prepared step-by-step guides for each type:

Deployment Guides

...

how to run Ansible Playbooks from your local working environment

...

and configure existing compute instances or automate Morpheus UI configuration steps.

...

Deploying a Terraform Module

...

Info

Page under construction

Learn how to initialize, plan, and apply Terraform modules for provisioning and managing the state of EWC

...

infrastructure (i.

...

[Deploying a Helm Chart](ADD LINK to PAGE) (optional — add if you create this page)
Learn how to install, upgrade, and manage applications using Helm.

...

[Deploying with the EWC CLI (optional)](ADD LINK to PAGE)
The EWC CLI is a Python-based tool (currently under development) that will allow you to deploy compatible Community Hub items directly into the EWC environment with minimal setup.

e. OpenStack compute instances, OpenStack networks and security groups, etc.).

Deploying a Docker Container

Info

Page under construction

Learn how to reuse publicly available Docker images to simplify minimize the setup required to run applications, regardless of their software or hardware dependencies.

Deploying a Helm Chart

Info

Page under construction

Learn how to deploy full applications or support systems onto production-like environments hosted on the EWC's own Kubernetes engine.

Deploying new instances and applying Ansible Playbooks on them with the ewccli

Info

Page under construction

The ewccli is a Linux-native Python-based tool which allows you to interact with a subset of the deployable Items, and deploy them directly into the your EWC tenancy and with minimal setup required on your local working environment.

...