Getting_Started.md

Getting Started

This section will give you the general description on how to get started running any of the provided bundles in Easy2Use.

Prerequisites

To be able to run Easy2Use, make sure you have decided on a hosting environment and installed and/or set up client access for Docker/Minikube/etc accordingly.

Quick Getting Started Guide

Easy2Use Cheatsheet

Clone the Easy2Use repository

git clone https://github.com/eiffel-community/eiffel-easy2use.git
cd eiffel-easy2use

Deploy Your Chosen Easy2Use Bundle

./easy2use start <bundle name>

List Deployed Services and User & Passwords

./easy2use list <bundle name>

Stop Deployed Services

./easy2use remove <bundle name>

Easy2Use CLI Help

If you need to know more about the startup procedures please read the detailed guide below, or use the built-in help in Easy2Use:

./easy2use --help

Easy2Use User Configuration

file ./config-user.bash

This file needs to be created manually, this file is NOT tracked by Git.

Configuration examples for Cx bundle to configure Image registry :

# Image Registry and Repository
export CX_IMAGE_REGISTRY="registry.hub.docker.com"
export CX_IMAGE_REPOSITORY="myregistry"

# Argo Credentials for Image Registry 
export CX_IMAGE_REPOSITORY_ARGO_K8S_SECRET_USER="myuser"
export CX_IMAGE_REPOSITORY_ARGO_K8S_SECRET_PSW="mypassword"

See file ./config-default.bash for more configuration candidates.