Skip to content

A Civo Pulumi resource package, providing multi-language access to Civo

License

Notifications You must be signed in to change notification settings

pulumi/pulumi-civo

Actions Status Slack NPM version Python version NuGet version PkgGoDev License

Civo Resource Provider

The Civo Resource Provider lets you manage Civo resources.

Installing

This package is available in many languages in the standard packaging formats.

Node.js (Java/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

$ npm install @pulumi/civo

or yarn:

$ yarn add @pulumi/civo

Python

To use from Python, install using pip:

$ pip install pulumi_civo

Go

To use from Go, use go get to grab the latest version of the library

$ go get github.com/pulumi/pulumi-civo/sdk/v2

.NET

To use from .NET, install using dotnet add package:

$ dotnet add package Pulumi.Civo

Configuration

The following configuration points are available:

  • civo:token - (Required) This is the Civo API token. It can also be sourced from the CIVO_TOKEN environment variable.
  • civo:region - (Optional) Region in which to create Civo resources. It can also be sourced from the CIVO_REGION environment variable.
  • civo:credentialsFile - Path to the Civo credentials file. Can be specified using CIVO_CREDENTIAL_FILE` environment variable.

Other: apiEndpoint

Using credentials file

The format of the credentials file is as follows:

{
    "apikeys": {
        "tf_key": "write-your-token-here"
    },
    "meta": {
        "current_apikey": "tf_key"
    }
}

You will then need to configure the credentials_file input to the correct location, for example:

credentialsFile = "/secure/path/civo.json"

Reference

For further information, please visit the Civo provider docs or for detailed reference documentation, please visit the API docs.