Skip to content

Commit 8fc9d3f

Browse files
committed
make virtualbox usage clearer
1 parent 37e8cb7 commit 8fc9d3f

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

docs/tutorials/setup_workstation.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ The tools you need to install are:
99
- Python 3.10 or later + a Python virtual environment
1010
- git client for version control (Configured for the current user, with read-write access for Repository Contents and Workflows.)
1111

12+
If you prefer to use a virtual machine, we provide a VirtualBox appliance with all the software pre-installed. This is the easiest way to get started.
13+
1214
Visual Studio Code is recommended because it has excellent integration with
1315
devcontainers. It also has useful extensions for working with Kubernetes,
1416
EPICS, Yaml files and more.
@@ -57,23 +59,29 @@ In all cases you will need an internet connection to download the software and t
5759
(appliance)=
5860
## VirtualBox Appliance
5961

60-
If you already have a linux distribution with admin permissions then go to {ref}`installation-steps` below.
61-
62-
63-
::: {important}
64-
For some tutorials you will need write access to a project in your personal github. We recommend using the PAT method described in the 1st section above.
65-
:::
62+
This section is for those that want to use a virtual machine to run the tutorials. If you already have a linux distribution with admin permissions and you want to work with that instead, please go to {ref}`installation-steps` below.
6663

6764
If you are using a Mac or Windows then the simplest approach is to use the Linux Virtual Machine with pre-installed software that we provide.
6865

6966
First install [VirtualBox](https://www.virtualbox.org/wiki/Downloads) and then download the [Virtual Machine](https://drive.google.com/file/d/1AZ1ptVqTV4-YjCsNKQXdjOkA-d77hWp7/view?usp=sharing). The downloaded file is an OVA file which can be imported into VirtualBox using ``File->Import Appliance ...``
7067

7168
During the import process you will be able to modify the resources that the VM uses, the defaults are recommended, but you may decrease them if your host machine has limited resources. We recommend 8GB of RAM and 4 CPUs for the VM but more is better for the developer container tutorials!
7269

73-
When the appliance is started you can log in as `ec-demo` with password `demo1`.
70+
Now start the VM and log in as `ec-demo` with password `demo1`.
7471

75-
Now jump to {ref}`cli-completion` below.
72+
This VM has the following software pre-installed:
73+
- Ubuntu 22.04
74+
- Python 3.10
75+
- Visual Studio Code
76+
- Docker
77+
- zsh shell with oh-my-zsh
78+
79+
You will need to complete the following steps to personalize the VM:
80+
- Set up your github credentials
81+
- Set up your python virtual environment
82+
- Set up your docker or podman CLI completion if you want it
7683

84+
Now jump to {ref}`cli-completion` below.
7785

7886

7987
(installation-steps)=
@@ -217,6 +225,18 @@ If you don't already have git installed see
217225
<https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>. Any recent
218226
version of git will work.
219227

228+
You will also want to set up your git user name and email address:
229+
230+
```bash
231+
git config --global user.name "Your Name"
232+
git config --global user.email "your email"
233+
```
234+
235+
And set up your git credentials so that you can access your personal github repositories. Your choices are:
236+
237+
- use a Personal Access Token (PAT) as described in the first section above.
238+
- setup an ssh key following the instructions [here](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account).
239+
220240
### Kubernetes
221241

222242
You don't need Kubernetes yet.

0 commit comments

Comments
 (0)