This package provides support for working with Spheron Compute organization.
### Usage
The package exports `SpheronClient` class, which includes methods for working with clusters, marketplace apps, cluster instances and their configurations. The constructor of `SpheronClient` takes in one parameter `token`. Check the **Access Token** section for information on how to create a token.
```js
import SpheronClient from "@spheron/compute";
...
const client = new SpheronClient({ token });
await client.instance.create(
clusterName: clusterName,
configuration: {
image: dockerImage,
tag: dockerImageTag,
instanceCount: numberOfInstances,
ports: [{ containerPort: containerPort, exposedPort: exposedPort }],
env: [{ key:"key", value: "value", isSecret: isSecret }],
commands: [],
args: [],
region: deployRegion,
machineImageName: computeMachineName,
},
healthCheckConfig: {
path: healthCheckPath,
port: healthCheckPort,
},
}
);
```
For more information about the Compute methods, check out the [DOCS](https://docs.spheron.network/sdk/compute/)
## Access Token
To create the `token` that is used with the `SpheronClient`, follow the instructions in the [DOCS](https://docs.spheron.network/rest-api/#creating-an-access-token). When you are creating the tokens, please choose **compute** type in the dashboard.
## Learn More
You can learn more about Spheron and Compute SDK here:
- [Spheron Discord](https://discord.com/invite/ahxuCtm)
- [Spheron Twitter](https://twitter.com/SpheronFdn)
