Quickstart Environment¶
The quickstart environment is a pre-configured environment based around the Coco Pharmaceuticals scenarios, designed for learning and experimentation. It is a good starting point for those who are new to Egeria and want to get a feel for the platform without having to configure everything from scratch.
The instructions below will guide you through the process of setting up the environment on you own computer. There is also a public version of the environment that you can use to explore Egeria, called the Egeria Quickstart Demo Sandbox.
Up and running with Quickstart¶
These are the steps to get up and running with your chosen egeria-workspaces environment:
1. Download and install a Docker hosting environment
The Egeria community typically uses Docker Desktop which is free for individuals, and offers a selection of plans for businesses that wish to create a supported environment. Alternatively you could use something like Podman or Vagrant to run the environment.
2. Download and install git (optional, but simplifies the process of keeping Egeria up to date)
Git is a source code management system that provides access to Egeria's code. Type the command git -v to see if it is installed. If the git command is not recognized, the Install Git guide provides instructions for various operating systems.
3. Download Egeria's workspaces' Git repository
Egeria's workspaces' git repository is on GitHub. There are three approaches, a simple download, a git clone or using a git fork and clone. The latter two are recommended because they make it easy to refresh your environment with the latest workspaces function. However, they do require 'git' to be installed on your local machine (see step above).
The fork and clone method is only needed if you think you may wish to contribute some of your work to the Egeria project. You need a GitHub account to create a fork. (How to create a GitHub account if you do not already have one.).
Download the latest version of Egeria's workspaces from GitHub by clicking on the green Code button and selecting Download ZIP.
Unzip the file and change to the egeria-workspaces directory.
From a command window, create a new directory (folder) for Egeria's workspaces on your local machine.
mkdir egeria-workspaces
Change to your new directory.
cd egeria-workspaces
Egeria's workspaces files are extracted from GitHub using the following git command:
git clone https://github.com/odpi/egeria-workspaces.git
A new directory has been created with the workspaces' source code. Change to the egeria-workspaces directory and you are ready to build the source.
cd egeria-workspaces
From a command window, create a new directory (folder) for Egeria's workspaces on your local machine.
mkdir egeria-workspaces
Change to your new directory.
cd egeria-workspaces
Egeria's workspaces files are extracted from GitHub using the following git command. Replace USER with your GitHub user name:
$ git clone https://github.com/USER/egeria-workspaces.git
A new directory has been created with the workspaces' source code. Change to the egeria-workspaces directory and you are ready to build the source.
cd egeria-workspaces
Next set-up the upstream repository to connect your clone to the main Egeria repository:
$ git remote add upstream https://github.com/odpi/egeria-workspaces.git
Finally check that all is set up correctly:
$ git remote -v
origin https://github.com/USER/egeria-workspaces.git (fetch)
origin https://github.com/USER/egeria-workspaces.git (push)
upstream https://github.com/odpi/egeria-workspaces.git (fetch)
upstream https://github.com/odpi/egeria-workspaces.git (push)
$
The ls command allows you to list the files from the repository:
ls
It should be the same as the contents of the git repository on GitHub.
4. "Run the start-up command
Now, from the egeria-workspaces directory,
run the start up command.
if everything is to run on a single computer use the following command to start the environment:
./quick-start-local
If you want to run Egeria as a server, that people can connect to from their own machines use the following command to start the environment:
./quick-start-multi-host`
The script will download all the software needed by Egeria and start it up. Once it has completed, you are ready to go ...
5. Select a persona
Selecting a persona logs you into the quickstart environment with the credentials for that persona. This effects the view of the metadata, and access priviliges you have when exploring the system. No-one can see everything. So pick a persona closest to your interest. For example, if you are interested in metadata about systems, pick Gary Geeke, if you like to explore their data governance program, pick Jules Keeper and so on.
The persona supported by the Quickstart environment are:
- Erin Overview - Erin is an information architect involved in the data governance program and the data aspects of their business transformation.
- Gary Geeke - Gary is their infrastructure lead. He is building the inventory of their systems and a governance program on top.
- Jules Keeper - Jules is the CDO, responsible for the data governance program.
- Peter Profile - Peter is a Data Engineer working on digital products and the supply chains used for clinical trials.
- Callie Quartile - Callie is a data scientist working on clinical trials.
- Ivor Padlock - Ivor is the head of security and is setting up their security governance.
- Faith Broker - Faith is the head of HR and CPO and so is interested in the protection of personal data.
- Polly Tasker - Polly is a senior IT Project Manager and is responsible for the IT governance program.
- Tom Tally - Tom leads the sustainability program.
- Lemmie Stage - Lemmie is a DevOps specialist looking to automae the capture of the IT landscape.
- Stew Faster - Stew is head of manufacturing. He is leading the digitization of the manufacturing plants.
6. Start exploring the open metadata ecosystem
You are ready to go. There are no set paths to follow, however, each of the scenarios includes suggestions on how to explore Egeria in the context of that scenario.
Inside the Quickstart environment¶
Raise an issue or comment below