Skip to content

Commit

Permalink
Merge pull request #163 from epics-containers/minor-fixes
Browse files Browse the repository at this point in the history
ec-cli --> edge-containers-cli
  • Loading branch information
gilesknap authored Sep 4, 2024
2 parents 755cd6c + 8b04f45 commit d759bfe
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
6 changes: 4 additions & 2 deletions docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ epics-containers supports two kinds of services repositories:
- **Kubernetes** services repositories. These are for deployment into a Kubernetes cluster. Each repository contains a set of **Helm Charts** all of which will deploy into a single namespace in a single Kubernetes Cluster.
- **Local Machine** services repositories. These are for deployment to a local machine using docker-compose. Each repository contains a set *compose.yaml* files that describe how to deploy a set of services to the local machine. These could potentially be used for production at a facility which does not use Kubernetes, but are primarily for development, testing and the earlier tutorials in this documentation.

(ec-cli)=
## ec-cli
(edge-containers-cli)=
## edge-containers-cli

A Python command line tool for the developer that runs *outside* of containers. It provides simple features for and monitoring and managing and IOC instances within a [](services-repo).

The entry point is `ec`.


(ibek)=
## ibek
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/setup_k8s_new_beamline.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,11 @@ If you have brought your own cluster then you may need to edit the **environment

## Setup the epics containers CLI

To deploy and manage IOC istances requires **helm** and **kubectl** command line tools. However we supply a simple wrapper for these tools that saves typing and helps with learning the commands. Go ahead and add the `ec-cli` python package to your virtual environment.
To deploy and manage IOC istances requires **helm** and **kubectl** command line tools. However we supply a simple wrapper for these tools that saves typing and helps with learning the commands. Go ahead and add the `edge-containers-cli` python package to your virtual environment if it is not already there.

```bash
# make sure your Python virtual environment is active, then:
pip install ec-cli
pip install edge-containers-cli
# setup the environment for ec to know how to talk to the cluster
# (make sure you are in the t03-services directory)
source ./environment.sh
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/setup_workstation.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ Above we set up a python virtual environment. Now we will install `copier` which

```bash
pip install copier
pip install ec-cli
pip install edge-containers-cli
```

### Git
Expand Down

0 comments on commit d759bfe

Please sign in to comment.