-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: AbstractionFactory <[email protected]>
- Loading branch information
1 parent
9540eb4
commit 6630034
Showing
25 changed files
with
202 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,33 @@ | ||
--- | ||
title: The OpenTofu Registry | ||
sidebar_title: Overview | ||
sidebar_position: 1 | ||
--- | ||
|
||
# The OpenTofu Registry | ||
|
||
The OpenTofu Registry provides an API for OpenTofu to locate providers and modules. This documentation will guide you through the most important steps in using the registry or publishing your modules and providers. Please select the topic you are interested in from the left sidebar. | ||
The OpenTofu Registry provides an API for OpenTofu to locate providers and modules. This documentation will guide you through the most important steps in using the registry or publishing your modules and providers. | ||
|
||
## For users | ||
|
||
This section contains the documentation for OpenTofu users. | ||
|
||
- [Overview](users) | ||
- [Using a provider](users/providers) | ||
- [Using a module](users/modules) | ||
- [Security](users/security) | ||
|
||
## For provider authors | ||
|
||
This section guides you through the steps of creating and publishing an OpenTofu provider. | ||
|
||
- [Overview](providers) | ||
- [Creating a provider](providers/creating) | ||
- [Publishing your provider](providers/publishing) | ||
- [Adding GPG signatures](providers/gpg) | ||
- [Writing docs for your provider](providers/docs) | ||
- [Adding a provider to the registry](providers/adding) | ||
|
||
## For module authors | ||
|
||
This section shows you how to create and publish a module. | ||
|
||
- [Overview](modules) | ||
- [Creating a module](modules/creating) | ||
- [Publishing a module](modules/publishing) | ||
- [Adding a module to the OpenTofu Registry](modules/adding) | ||
|
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Adding your module to the OpenTofu registry |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Creating an OpenTofu module |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# The OpenTofu Registry for Module Authors | ||
|
||
This section shows you how to create and publish a module. | ||
|
||
- [Creating a module](modules/creating) | ||
- [Publishing a module](modules/publishing) | ||
- [Adding a module to the OpenTofu Registry](modules/adding) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Publishing an OpenTofu module |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Adding your provider to the OpenTofu Registry |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Creating an OpenTofu provider |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Writing documentation for your provider |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Adding GPG signatures for your release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# The OpenTofu Registry for Provider Authors | ||
|
||
This section of the documentation guides you through the basic steps of creating and publishing a provider in the OpenTofu Registry. The documentation assumes you are familiar with the Go programming language. | ||
|
||
## In this section | ||
|
||
- [Creating a provider](providers/creating) | ||
- [Publishing your provider](providers/publishing) | ||
- [Adding GPG signatures](providers/gpg) | ||
- [Writing docs for your provider](providers/docs) | ||
- [Adding a provider to the registry](providers/adding) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Publishing a provider version |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,9 @@ | ||
--- | ||
title: The OpenTofu Registry for Users | ||
sidebar_title: For user | ||
sidebar_position: 100 | ||
--- | ||
# The OpenTofu Registry for Users | ||
|
||
OpenTofu is but a tool that works with integrations made by the community called *providers*. In addition to that, community-made modules simplify many common tasks. The OpenTofu Registry contains an index pointing to thousands of providers and tends of thousands of modules on GitHub you can use. You can install them automatically by adding a code snippet to your project and running `tofu init`. | ||
|
||
## In this chapter | ||
|
||
- [Using a provider](users/providers) | ||
- [Using a module](users/modules) | ||
- [Security](users/security) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,9 @@ | ||
--- | ||
title: Using a module | ||
sidebar_title: Using a module | ||
sidebar_position: 102 | ||
--- | ||
# Using a module | ||
|
||
Modules provide reusable pieces of code for your OpenTofu project. The OpenTofu Registry contains references to over 20.000 modules on GitHub created by the community. You can [find a module for your use case using the OpenTofu Registry Search](https://search.opentofu.org/modules/). You can learn more about how modules work in OpenTofu from the [OpenTofu documentation](https://opentofu.org/docs/language/modules/). | ||
|
||
~> The OpenTofu Registry does not perform security scanning on modules, and they may contain malicious code. Inspect any module you intend to use and only use modules from authors you trust. | ||
|
||
## Integrating a module in your project | ||
|
||
Module addresses have three parts: namespaces, names, and target systems. For example, the |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,54 @@ | ||
--- | ||
title: Using a provider | ||
sidebar_title: Using a provider | ||
sidebar_position: 101 | ||
--- | ||
# Using a provider | ||
|
||
Providers give OpenTofu the ability to call various APIs. The OpenTofu registry currently holds over 4000 such providers created by the community. They provide integrations for a vast range of services, from cloud providers, such as [AWS](https://search.opentofu.org/provider/hashicorp/aws/latest), [Azure](https://search.opentofu.org/provider/hashicorp/azurerm/latest), [GCP](https://search.opentofu.org/provider/hashicorp/google/latest) and more, version control systems, such as [GitHub](https://search.opentofu.org/provider/integrations/github/latest), [Gitlab](https://search.opentofu.org/provider/gitlabhq/gitlab/latest), to password manages like [1Password](https://search.opentofu.org/provider/1password/onepassword/latest). You can explore the providers available [using the OpenTofu Registry Search](https://search.opentofu.org/providers/) or learn more about how providers work in OpenTofu using the [OpenTofu documentation](https://opentofu.org/docs/language/providers/). | ||
|
||
~> Providers are binary programs created by their authors that run on your machine. The OpenTofu Registry does not perform security scanning on providers, and they may contain malicious code. There is also no guarantee that the provider binary was compiled from the code in the linked GitHub repository. Only use providers from authors you trust. | ||
|
||
## Integrating a provider into your project | ||
|
||
Once you found a provider for your needs, you can add it to your OpenTofu project in the `terraform` block: | ||
|
||
```hcl2 | ||
terraform { | ||
required_providers { | ||
PROVIDER_NAME_HERE = { | ||
source = "NAMESPACE_HERE/PROVIDER_NAME_HERE" | ||
version = "PROVIDER_VERSION_HERE" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
You can then configure your provider as follows: | ||
|
||
```hcl2 | ||
provider "PROVIDER_NAME_HERE" { | ||
option1 = "value1" | ||
option2 = "value2" | ||
} | ||
``` | ||
|
||
For example, you can configure and use the GitHub provider like this: | ||
|
||
```hcl2 | ||
terraform { | ||
required_providers { | ||
integrations = { | ||
source = "integrations/github" | ||
version = "v6.2.3" | ||
} | ||
} | ||
} | ||
variable "github_token {} | ||
provider "github" { | ||
token = var.github_token | ||
} | ||
resource "github_repository" "myrepo" { | ||
name = "myrepo" | ||
} | ||
``` | ||
|
||
-> Provider namespaces and names in the OpenTofu registry translate directly to GitHub URLs in the form of `github.com/NAMESPACE/terraform-provider-NAME`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1 @@ | ||
--- | ||
title: Security in the OpenTofu Registry | ||
sidebar_title: Security | ||
sidebar_position: 103 | ||
--- | ||
# Security in the OpenTofu Registry |