From bc78c5e0d6f2b7a0719959024fb65ea01bce1770 Mon Sep 17 00:00:00 2001 From: Zach Date: Wed, 27 Sep 2023 17:07:30 -0400 Subject: [PATCH 1/3] Update README.md (#544) --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 4f1f93c2..a888895e 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ Ensure that the following are already installed: - [Python3](https://wiki.python.org/moin/BeginnersGuide/Download): `python3 --version` >= `3.8.10` (the Python3 shipped in Ubuntu 20+ is good to go) - [Docker](https://docs.docker.com/get-docker/): `docker --version` >= `20.10.21` - [jq](https://stedolan.github.io/jq/download/): `jq --version` >= `1.5` +- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git): `git --version` >= `2.10.3` Note: if installing docker-compose via package manager on Linux (as opposed to Docker Desktop), you must [install the plugin](https://docs.docker.com/compose/install/linux/#install-the-plugin-manually), e.g. : -- 2.45.2 From 33e443f41f040d9092386d727d6050bc1257094b Mon Sep 17 00:00:00 2001 From: Zach Date: Wed, 27 Sep 2023 17:36:12 -0400 Subject: [PATCH 2/3] Gitea x Laconicd + some doc updates (#549) * combine instructions from 2 stacks Former-commit-id: 77d194cfd9b0503c3e55e8c79429fa1f36a8d784 * tidy doc --------- Co-authored-by: zramsay --- docs/README.md | 8 ++ docs/cli.md | 2 +- docs/gitea-with-laconicd-fixturenet.md | 80 +++++++++++++++++++ ...fixturenet.md => laconicd-with-console.md} | 0 docs/spec.md | 3 +- 5 files changed, 90 insertions(+), 3 deletions(-) create mode 100644 docs/README.md create mode 100644 docs/gitea-with-laconicd-fixturenet.md rename docs/{laconicd-fixturenet.md => laconicd-with-console.md} (100%) diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..a3146301 --- /dev/null +++ b/docs/README.md @@ -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) diff --git a/docs/cli.md b/docs/cli.md index 287d6c68..e9f06108 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -6,7 +6,7 @@ Sub-commands and flags 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: ``` diff --git a/docs/gitea-with-laconicd-fixturenet.md b/docs/gitea-with-laconicd-fixturenet.md new file mode 100644 index 00000000..f0b3e804 --- /dev/null +++ b/docs/gitea-with-laconicd-fixturenet.md @@ -0,0 +1,80 @@ +# Gitea x NPMs X Laconicd + +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 + +### Build and Deploy Gitea + +```bash +laconic-so --stack build-support build-containers +laconic-so --stack package-registry setup-repositories +laconic-so --stack package-registry build-containers +laconic-so --stack package-registry deploy up +``` + +These commands can take awhile. Eventually, some instructions and a token will output. Set `CERC_NPM_AUTH_TOKEN`: + +```bash +export CERC_NPM_AUTH_TOKEN= +``` + +### 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): + +```bash +127.0.0.1 gitea.local +``` + +Test with: + +```bash +ping gitea.local +``` + +```bash +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=2 ttl=64 time=0.033 ms +``` + +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). + +### Build npm Packages + +Clone the required repositories: + +```bash +laconic-so --stack fixturenet-laconicd setup-repositories +``` + +Build and publish the npm packages: + +```bash +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: + +- `@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 deploy up +``` + +Check the logs: + +```bash +laconic-so --stack fixturenet-laconicd deploy logs +``` + +### Test with the registry CLI + +```bash +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). diff --git a/docs/laconicd-fixturenet.md b/docs/laconicd-with-console.md similarity index 100% rename from docs/laconicd-fixturenet.md rename to docs/laconicd-with-console.md diff --git a/docs/spec.md b/docs/spec.md index ad6ed3c9..1dc9ac62 100644 --- a/docs/spec.md +++ b/docs/spec.md @@ -1,7 +1,6 @@ # 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 -- 2.45.2 From 97b987efe43417099cb6e1e3b2c6b17f3a3bd793 Mon Sep 17 00:00:00 2001 From: David Boreham Date: Wed, 27 Sep 2023 15:51:34 -0600 Subject: [PATCH 3/3] Document adding config.yml --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 4f1f93c2..d3bf16ba 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,11 @@ Verify operation (your version will probably be different, just check here that laconic-so version Version: 1.1.0-7a607c2-202304260513 ``` +Save the distribution url to `~/.laconic-so/config.yml`: +```bash +mkdir ~/.laconic-so +echo "distribution-url: https://github.com/cerc-io/stack-orchestrator/releases/latest/download/laconic-so" > ~/.laconic-so/config.yml" +``` ### Update If Stack Orchestrator was installed using the process described above, it is able to subsequently self-update to the current latest version by running: -- 2.45.2