Skip to content
This repository has been archived by the owner on Mar 28, 2024. It is now read-only.

Latest commit

 

History

History
93 lines (59 loc) · 3.11 KB

README.md

File metadata and controls

93 lines (59 loc) · 3.11 KB
Raw

Terraform Provider for Juju

Warning The provider is under active development and will initially support only some Juju functionality. Use releases at your own risk.

The provider can be used to interact with Juju - a model-driven Operator Lifecycle Manager (OLM).

Initial Scope

Once complete, the initial released version of the provider will allow you to:

  • Manage models,
  • Deploy charms from CharmHub,
  • Manage integrations (previously named "relationships").

There will also be support for importing these existing Juju resources.

Requirements

Building The Provider

  1. Clone the repository
  2. Enter the repository directory
  3. Build the provider using the Go install command:
go install

Adding Dependencies

This provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.

To add a new dependency github.com/author/dependency to your Terraform provider:

go get github.com/author/dependency
go mod tidy

Then commit the changes to go.mod and go.sum.

Using the Provider

Please, refer to the Terraform docs for the Juju provider.

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

To generate or update documentation, run go generate.

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources.

Prior to running the tests locally, ensure you have the following environmental variables set:

  • JUJU_CONTROLLER_ADDRESSES
  • JUJU_USERNAME
  • JUJU_PASSWORD
  • JUJU_CA_CERT

For example, here they are set using the currently active controller:

CONTROLLER=$(juju whoami | yq .Controller)
export JUJU_CONTROLLER_ADDRESSES="$(juju show-controller | yq .$CONTROLLER.details.api-endpoints | tr -d "[]' ")"
export JUJU_USERNAME="$(cat ~/.local/share/juju/accounts.yaml | yq .controllers.$CONTROLLER.user)"
export JUJU_PASSWORD="$(cat ~/.local/share/juju/accounts.yaml | yq .controllers.$CONTROLLER.password)"
export JUJU_CA_CERT="$(juju show-controller $CONTROLLER | yq .$CONTROLLER.details.ca-cert)"

Then, finally, run the tests:

make testacc

Linting

This repository uses golangci-lint as a linting tool as it can run multiple linters. The configuration for this tool is all handled in the file .golangci.yaml in the root of the repository allowing all runs of the tool to run with the same settings. When installed you can run the analysis with:

golangci-lint run

You can also integrate golangci-lint with some IDEs following instructions available here: Editor integration