-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update the readme with pertinent information
Signed-off-by: Boris Kurktchiev <boris@nirmata.com>
- Loading branch information
1 parent
ef13fc0
commit 0abf3a6
Showing
1 changed file
with
43 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,47 @@ | ||
# back-stack | ||
|
||
Introducing the BACK Stack | ||
# The BACK Stack | ||
|
||
Find out more [backstack.dev](https://backstack.dev) | ||
|
||
Basic architecture of the stack: | ||
![architecture diagram](./imgs/arch.svg) | ||
|
||
Watch the Kubecon session: [Introducing the BACK Stack!](https://youtu.be/SMlR12uwMLs) | ||
|
||
## Prerequisites | ||
For a local install, you need kind installed and a bash-compatible shell. | ||
|
||
## Getting started | ||
- Fork and clone this repo | ||
```sh | ||
gh repo fork back-stack/showcase --clone | ||
``` | ||
- Create a personal access token [link](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) | ||
- Configure `./.env` with your personal access token, the repository url, the vault token, your provider-azure credentials [see here](https://marketplace.upbound.io/providers/upbound/provider-family-azure/v0.38.2/docs/configuration), and your provider-aws credentials [see here](https://marketplace.upbound.io/providers/upbound/provider-family-aws/v0.43.1/docs/configuration) | ||
|
||
```properties | ||
GITHUB_TOKEN=<personal access token> | ||
REPOSITORY=https://github.com/<path to forked repo> | ||
VAULT_TOKEN=root # this is the default for 'dev' mode | ||
AZURE_CREDENTIALS='{"clientId": "xxx","clientSecret": "xxx","subscriptionId": "xxx","tenantId": "xxx","activeDirectoryEndpointUrl": "https://login.microsoftonline.com","resourceManagerEndpointUrl": "https://management.azure.com/","activeDirectoryGraphResourceId": "https://graph.windows.net/","sqlManagementEndpointUrl": "https://management.core.windows.net:8443/","galleryEndpointUrl": "https://gallery.azure.com/","managementEndpointUrl": "https://management.core.windows.net/"}' | ||
AWS_ACCESS_KEY_ID="xxx" | ||
AWS_SECRET_ACCESS_KEY="xxx" | ||
AWS_SESSION_TOKEN="xxx" | ||
``` | ||
|
||
- Run the installer | ||
```sh | ||
./local-install.sh | ||
``` | ||
Watch the KubeCon NA 2023 session: [Introducing the BACK Stack!](https://youtu.be/SMlR12uwMLs) | ||
|
||
## Install the BACK Stack | ||
|
||
In order to try out the BACK Stack locally you can follow these steps | ||
|
||
### Prerequisites | ||
|
||
For a local install, you need Docker and Kind pre-installed. | ||
|
||
### Getting started | ||
|
||
Fork and clone the `showcase` repository | ||
|
||
```sh | ||
git clone git@github.com:back-stack/showcase.git | ||
``` | ||
|
||
#### Setup Variables | ||
|
||
- [Create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) | ||
- Configure `./.env` with your personal access token, the repository url, the vault token, your [provider-azure credentials](https://marketplace.upbound.io/providers/upbound/provider-family-azure/v0.38.2/docs/configuration), and your [provider-aws credentials](https://marketplace.upbound.io/providers/upbound/provider-family-aws/v0.43.1/docs/configuration) | ||
|
||
```sh | ||
$ cat << EOF > .env | ||
GITHUB_TOKEN=<personal access token> | ||
REPOSITORY=https://github.com/<path to forked repo> | ||
VAULT_TOKEN=root # this is the default for 'dev' mode | ||
AZURE_CREDENTIALS='{"clientId": "xxx","clientSecret": "xxx","subscriptionId": "xxx","tenantId": "xxx","activeDirectoryEndpointUrl": "https://login.microsoftonline.com","resourceManagerEndpointUrl": "https://management.azure.com/","activeDirectoryGraphResourceId": "https://graph.windows.net/","sqlManagementEndpointUrl": "https://management.core.windows.net:8443/","galleryEndpointUrl": "https://gallery.azure.com/","managementEndpointUrl": "https://management.core.windows.net/"}' | ||
AWS_ACCESS_KEY_ID="xxx" | ||
AWS_SECRET_ACCESS_KEY="xxx" | ||
AWS_SESSION_TOKEN="xxx" | ||
EOF | ||
``` | ||
|
||
#### Run Installer | ||
|
||
```sh | ||
./local-install.sh | ||
``` |