This commit is contained in:
zramsay 2023-09-22 17:47:27 -04:00
parent 6405fd973e
commit 846c8a81ef
5 changed files with 38 additions and 56 deletions

8
docs/README.md Normal file
View File

@ -0,0 +1,8 @@
# Stack Orchestrator
Here you will find information about the design of stack orchestrator, contributing to it, and deploying services/applications that combine two or more "stacks".
Most "stacks" contain their own README which has plenty of information on deploying, but stacks can be combined in a variety of ways which are document here, for example:
- [Gitea with Laconicd Fixturenet](./gitea-with-laconicd-fixturenet.md)
- [Laconicd Registry with Console](./laconicd-with-console.md)

View File

@ -6,7 +6,7 @@ Sub-commands and flags
Clone a single repository: Clone a single repository:
``` ```
$ laconic-so setup-repositories --include cerc-io/go-ethereum $ laconic-so setup-repositories --include github.com/cerc-io/go-ethereum
``` ```
Clone the repositories for a stack: Clone the repositories for a stack:
``` ```

View File

@ -1,60 +1,37 @@
# Using SO to deploy Gitea then start a Laconicd fixturenet # Gitea x NPMs X Laconicd
## Build Support Stack Deploy a local Gitea server, publish NPM packages to it, then use those packages to build a Laconicd fixturenet. Demonstrates several components of the Laconic stack
JS/TS/NPM builds need an npm registry to store intermediate package artifacts. ### Build and Deploy Gitea
This can be supplied by the user (e.g. using a hosted registry or even npmjs.com), or a local registry using gitea can be deployed by stack orchestrator.
To use a user-supplied registry set these environment variables:
`CERC_NPM_REGISTRY_URL` and ```bash
`CERC_NPM_AUTH_TOKEN` laconic-so --stack build-support build-containers
Leave `CERC_NPM_REGISTRY_URL` un-set to use the local gitea registry.
### Build support containers
Note: the scheme/gerbil container is excluded as it isn't currently required for the package registry.
```
laconic-so --stack build-support build-containers --exclude cerc/builder-gerbil
```
### Deploy Gitea Package Registry
```
laconic-so --stack package-registry setup-repositories laconic-so --stack package-registry setup-repositories
laconic-so --stack package-registry build-containers laconic-so --stack package-registry build-containers
laconic-so --stack package-registry deploy up laconic-so --stack package-registry deploy up
``` ```
```
[+] Running 3/3
⠿ Network laconic-aecc4a21d3a502b14522db97d427e850_gitea Created 0.0s
⠿ Container laconic-aecc4a21d3a502b14522db97d427e850-db-1 Started 1.2s
⠿ Container laconic-aecc4a21d3a502b14522db97d427e850-server-1 Started 1.9s
New user 'gitea_admin' has been successfully created!
This is your gitea access token: 84fe66a73698bf11edbdccd0a338236b7d1d5c45. Keep it safe and secure, it can not be fetched again from gitea.
To use with laconic-so set this environment variable: export CERC_NPM_AUTH_TOKEN=3e493e77b3e83fe9e882f7e3a79dd4d5441c308b
Created the organization cerc-io
Gitea was configured to use host name: gitea.local, ensure that this resolves to localhost, e.g. with sudo vi /etc/hosts
Success, gitea is properly initialized
```
Note: the above commands can take several minutes depending on the specs of your machine. These commands can take awhile. Eventually, some instructions and a token will output. Set `CERC_NPM_AUTH_TOKEN`:
```bash
export CERC_NPM_AUTH_TOKEN=<your-token>
```
### Configure the hostname gitea.local ### Configure the hostname gitea.local
How to do this depends on your operating system but usually involves editing a `hosts` file. For example, on Linux add this line to the file `/etc/hosts` (needs sudo): How to do this depends on your operating system but usually involves editing a `hosts` file. For example, on Linux add this line to the file `/etc/hosts` (needs sudo):
``` ```bash
127.0.0.1 gitea.local 127.0.0.1 gitea.local
``` ```
Test with: Test with:
``` ```bash
ping gitea.local ping gitea.local
``` ```
```
```bash
PING gitea.local (127.0.0.1) 56(84) bytes of data. PING gitea.local (127.0.0.1) 56(84) bytes of data.
64 bytes from localhost (127.0.0.1): icmp_seq=1 ttl=64 time=0.147 ms 64 bytes from localhost (127.0.0.1): icmp_seq=1 ttl=64 time=0.147 ms
64 bytes from localhost (127.0.0.1): icmp_seq=2 ttl=64 time=0.033 ms 64 bytes from localhost (127.0.0.1): icmp_seq=2 ttl=64 time=0.033 ms
@ -62,44 +39,42 @@ PING gitea.local (127.0.0.1) 56(84) bytes of data.
Although not necessary in order to build and publish packages, you can now access the Gitea web interface at: [http://gitea.local:3000](http://gitea.local:3000) using these credentials: `gitea_admin/admin1234` (Note: please properly secure Gitea if public internet access is allowed). Although not necessary in order to build and publish packages, you can now access the Gitea web interface at: [http://gitea.local:3000](http://gitea.local:3000) using these credentials: `gitea_admin/admin1234` (Note: please properly secure Gitea if public internet access is allowed).
Now npm packages can be built:
### Build npm Packages ### Build npm Packages
Next, clone the required repositories: Clone the required repositories:
``` ```bash
laconic-so --stack fixturenet-laconicd setup-repositories laconic-so --stack fixturenet-laconicd setup-repositories
``` ```
Ensure that `CERC_NPM_AUTH_TOKEN` is set with the token printed above when the package-registry stack was deployed (the actual token value will be different than shown in this example): Build and publish the npm packages:
``` ```bash
export CERC_NPM_AUTH_TOKEN=84fe66a73698bf11edbdccd0a338236b7d1d5c45
```
```
laconic-so --stack fixturenet-laconicd build-npms laconic-so --stack fixturenet-laconicd build-npms
``` ```
Navigate to the Gitea console and switch to the `cerc-io` user then find the `Packages` tab to confirm that these two npm packages have been published. Navigate to the Gitea console and switch to the `cerc-io` user then find the `Packages` tab to confirm that these two npm packages have been published:
### Build fixturenet containers - `@cerc-io/laconic-registry-cli`
- `@cerc-io/laconic-sdk`
``` ### Build and deploy fixturenet containers
```bash
laconic-so --stack fixturenet-laconicd build-containers laconic-so --stack fixturenet-laconicd build-containers
laconic-so --stack fixturenet-laconicd deploy up
``` ```
Check the logs: Check the logs:
``` ```bash
laconic-so --stack fixturenet-laconicd deploy logs laconic-so --stack fixturenet-laconicd deploy logs
``` ```
### Test with the registry CLI ### Test with the registry CLI
``` ```bash
laconic-so --stack fixturenet-laconicd deploy exec cli "laconic cns status" laconic-so --stack fixturenet-laconicd deploy exec cli "laconic cns status"
``` ```
Try additional CLI commands, documented [here](https://github.com/cerc-io/laconic-registry-cli#operations). Note that in order to publish records, you'll need to `docker cp` the `watcher.yml` file. Try additional CLI commands, documented [here](https://github.com/cerc-io/laconic-registry-cli#operations).

View File

@ -1,7 +1,6 @@
# Specification # Specification
(note this page is out of date) Note: this page is out of date (but still useful) - it will no longer be useful once stacks are [decoupled from the tool functionality](https://github.com/cerc-io/stack-orchestrator/issues/315).
## Implementation ## Implementation