search

stargate / docs

Documentation for Stargate
Apache License 2.0
15 stars 24 forks source link

Document how to start Stargate v2 APIs in non-Docker deployments #251

Open jeffreyscarpenter opened 1 year ago

jeffreyscarpenter commented 1 year ago

We need to update the installation docs to describe how to start the Stargate v2 API services. The documents describe how to install/run the coordinator via the starctl script, we need something similar for each API.

This depends on resolution of the following issue:

jeffreyscarpenter commented 1 year ago

In particular, we have had multiple instances of developers who are familiar with Stargate v1 attempting to upgrade to Stargate v2 by simply downloading only the coordinator. When they attempt to use one of the APIs, they get "404 not found" errors because they have not started the API.

These sections need to be updated:

It's important that users are made aware that there are separate scripts for starting each API. These scripts are defined in the repo at the following locations:

The scripts are also included in a zip file for each API, which is included as part of the release contents. See for example: https://github.com/stargate/stargate/releases/tag/v2.0.8.

It's also important to note that starting the APIs requires Java 17. It is possible to start APIs on the same VM as the coordinator, but you'll need to have both Java 8 and Java 17 installed, and set JAVA_HOME appropriately before calling starctl (to point to Java 8), vs the start-*api scripts (to point to Java 17).