Skip to content

Commit

Permalink
behind the scenes after installation
Browse files Browse the repository at this point in the history
  • Loading branch information
IgnacioGoldman committed Nov 5, 2024
1 parent b6cdd24 commit 15a3ec6
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,17 @@ export TF_VAR_dt_api_token=dt0c01....
7. Run `terraform apply`
8. Grab a coffee, this process will take some time...

### Behind the scenes

Spinning up an ACE-Box instance can be split into two main parts:

1) Deploying a VM: This happens automatically when you use the included Terraform projects or you can bring your own VM.
2) After a VM is available, the provisioners install the ACE-Box framework. This process itself consists in a couple steps:
1) Working directory copy: everything in [user-skel](/user-skel) is copied to the VM local filesystem
2) Package manager update: [init.sh](/user-skel/init.sh) is run. This runs an `apt-get` update and installs `Python3.9`, `Ansible` and the `ace-cli`
3) `ace prepare` command is run, which asks for ACE-Box specific configurations (e.g. protocol, custom domain, ...)
4) Once the VM is prepared, `ace enable USECASE_NAME|USECASE_URL` command is run to perform the actual deployment of the modules (e.g: softwares, applications, ..) and implement the configurations that have been defined in the use-case's configuration files

## Use-cases
A use-case aim to reproduce real-world setups for purposes like feature demonstrations, hands-on training, or system testing. Each use-case is defined by a set of configuration files that ACE-Box uses to automatically deploy the necessary infrastructure and apply the required configurations on the systems.

Expand Down Expand Up @@ -155,15 +166,7 @@ Command | Result
`terraform plan -destroy` | view a speculative destroy plan, to see what the effect of destroying would be |
`terraform show` | Outputs the resources created by Terraform. Useful to verify IP addresses and the dashboard URL.

### Behind the scenes
Spinning up an ACE-Box instance can be split into two main parts:

1) Deploying a VM: This happens automatically when you use the included Terraform projects or you can bring your own VM.
2) After a VM is available, the provisioners install the ACE-Box framework. This process itself consists in a couple steps:
1) Working directory copy: everything in [user-skel](/user-skel) is copied to the VM local filesystem
2) Package manager update: [init.sh](/user-skel/init.sh) is run. This runs an `apt-get` update and installs `Python3.9`, `Ansible` and the `ace-cli`
3) `ace prepare` command is run, which asks for ACE-Box specific configurations (e.g. protocol, custom domain, ...)
4) Once the VM is prepared, `ace enable USECASE_NAME|USECASE_URL` command is run to perform the actual deployment of the modules (e.g: softwares, applications, ..) and implement the configurations that have been defined in the use-case's configuration files

<br>

Expand All @@ -172,7 +175,7 @@ Please see `LICENSE` in repo root for license details.

License headers can be added automatically be running `./tools/addlicenseheader.sh` (see file for details).

### Oauth client scopes
## Oauth client scopes

The recommended scopes for the Oauth client are:

Expand Down Expand Up @@ -205,6 +208,6 @@ app-engine:edge-connects:delete
app-settings:objects:read
```

### API token scopes
## API token scopes

Initial API token with scopes `apiTokens.read` and `apiTokens.write`. This token will be used by various roles to manage their own tokens.

0 comments on commit 15a3ec6

Please sign in to comment.