A Pulumi package for creating and managing fortios cloud resources.
Project description
Terraform Bridge Provider Boilerplate
This repository contains boilerplate code for building a new Pulumi provider which wraps an existing Terraform provider, if the existing provider uses Go Modules.
Modify this README to describe:
- The type of resources the provider manages
- Add a build status image from Travis at the top of the README
- Update package names in the information below
- Add any important documentation of concepts (e.g. the "serverless" components in the AWS provider).
Creating a Pulumi Terraform Bridge Provider
First, clone this repo with the name of the desired provider in place of fortios
:
git clone https://github.com/pulumi/pulumi-tf-provider-boilerplate pulumi-fortios
Second, replace references to fortios
with the name of your provider:
make prepare NAME=foo REPOSITORY=github.com/pulumi/pulumi-foo
Next, list the configuration points for the provider in the area of the README.
Note: If the name of the desired Pulumi provider differs from the name of the Terraform provider, you will need to carefully distinguish between the references - see https://github.com/pulumi/pulumi-azure for an example.
Add dependencies
In order to properly build the sdks, the following tools are expected:
pulumictl
(See the project's README for installation instructions: https://github.com/pulumi/pulumictl)
In the root of the repository, run:
(cd provider && go get github.com/terraform-providers/terraform-provider-fortios)
(wherefoo
is the name of the provider - note the parenthesis to run this in a subshell)(cd provider && go mod download)
Build the provider:
- Edit
provider/resources.go
to map each resource, and specify provider information make build_sdks
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/xyx
or yarn
:
$ yarn add @pulumi/xyx
Python
To use from Python, install using pip
:
$ pip install pulumi_xyx
Go
To use from Go, use go get
to grab the latest version of the library
$ go get github.com/pulumi/pulumi-fortios/sdk/go/...
Configuration
The following configuration points are available for the fortios
provider:
fortios:apiKey
(environment:XYZ_API_KEY
) - the API key forfortios
fortios:region
(environment:XYZ_REGION
) - the region in which to deploy resources
Reference
For detailed reference documentation, please visit the API docs.
Update provider
Update the version of github.com/fortinetdev/terraform-provider-fortios
in provider/go.mod
.
Next update and build the provider:
# update dependencies
(cd provider && go get -u && go mod tidy)
# update provider/resources.go
./update_scripts/update.sh
# build sdk's
make build_go && make build_nodejs && make build_python
Commit the changes, including the build sdks and tag the commit.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.