Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clivern/terraform-provider-boilerplate
🏄Terraform Provider Boilerplate.
https://github.com/clivern/terraform-provider-boilerplate
clivern infrastructure-as-code infrastructure-management terraform terraform-module terraform-modules terraform-provider
Last synced: 28 days ago
JSON representation
🏄Terraform Provider Boilerplate.
- Host: GitHub
- URL: https://github.com/clivern/terraform-provider-boilerplate
- Owner: Clivern
- License: mit
- Created: 2019-12-12T15:39:03.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-11T16:01:52.000Z (about 2 months ago)
- Last Synced: 2024-10-10T07:41:33.370Z (28 days ago)
- Topics: clivern, infrastructure-as-code, infrastructure-management, terraform, terraform-module, terraform-modules, terraform-provider
- Language: Go
- Homepage:
- Size: 110 KB
- Stars: 17
- Watchers: 2
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Terraform Provider Boilerplate.
## Documentation
First we need to create a simple web service to do a CRUD operations.
```golang
package main
import (
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"os"
"github.com/gin-gonic/gin"
)
type Server struct {
Id int `json:"id"`
Image string `json:"image"`
Name string `json:"name"`
Size string `json:"size"`
Region string `json:"region"`
}
// LoadFromJSON update object from json
func (s *Server) LoadFromJSON(data []byte) (bool, error) {
err := json.Unmarshal(data, &s)
if err != nil {
return false, err
}
return true, nil
}
// ConvertToJSON convert object to json
func (s *Server) ConvertToJSON() (string, error) {
data, err := json.Marshal(&s)
if err != nil {
return "", err
}
return string(data), nil
}
func Store(file, data string) (bool, error) {
f, err := os.Create(file)
if err != nil {
return false, err
}
_, err = f.WriteString(data)
if err != nil {
f.Close()
return false, err
}
err = f.Close()
if err != nil {
return false, err
}
return true, nil
}
func Retrieve(file string) string {
b, err := ioutil.ReadFile(file) // just pass the file name
if err != nil {
return ""
}
return string(b)
}
func main() {
gin.DisableConsoleColor()
gin.DefaultWriter = os.Stdout
r := gin.Default()
r.GET("/favicon.ico", func(c *gin.Context) {
c.String(http.StatusNoContent, "")
})
r.GET("/server/:name", func(c *gin.Context) {
data := Retrieve("db.txt")
if data == "" {
c.JSON(http.StatusNotFound, gin.H{
"status": "error",
"error": "Server not found",
})
return
}
server := &Server{}
server.LoadFromJSON([]byte(data))
c.JSON(http.StatusOK, gin.H{
"id": server.Id,
"image": server.Image,
"name": server.Name,
"size": server.Size,
"region": server.Region,
})
})
r.POST("/server", func(c *gin.Context) {
rawBody, err := c.GetRawData()
if err != nil {
c.JSON(http.StatusBadRequest, gin.H{
"status": "error",
"error": "Invalid request",
})
return
}
server := &Server{}
server.LoadFromJSON([]byte(rawBody))
server.Id = 1
data, _ := server.ConvertToJSON()
ok, err := Store("db.txt", data)
if !ok || err != nil {
c.JSON(http.StatusInternalServerError, gin.H{
"status": "error",
"error": "Internal Server Error",
})
return
}
c.JSON(http.StatusOK, gin.H{
"id": server.Id,
"image": server.Image,
"name": server.Name,
"size": server.Size,
"region": server.Region,
})
})
r.PUT("/server/:id", func(c *gin.Context) {
rawBody, err := c.GetRawData()
if err != nil {
c.JSON(http.StatusBadRequest, gin.H{
"status": "error",
"error": "Invalid request",
})
return
}
server := &Server{}
server.LoadFromJSON([]byte(rawBody))
server.Id = 1
data, _ := server.ConvertToJSON()
ok, err := Store("db.txt", data)
if !ok || err != nil {
c.JSON(http.StatusInternalServerError, gin.H{
"status": "error",
"error": "Internal Server Error",
})
return
}
c.JSON(http.StatusOK, gin.H{
"id": server.Id,
"image": server.Image,
"name": server.Name,
"size": server.Size,
"region": server.Region,
})
})
r.DELETE("/server/:id", func(c *gin.Context) {
Store("db.txt", "")
c.Status(http.StatusNoContent)
})
r.GET("/image/:slug", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{
"id": 1,
"slug": "UBUNTU_18_04_64BIT",
"name": "UBUNTU 18.04 64BIT",
"distribution": "UBUNTU",
"private": false,
"min_disk_size": 20,
})
})
r.Run(fmt.Sprintf(":%d", 8080))
}
```
Run this service on the background.
```bash
$ go run main.go
```
Then we can use our terraform provider to make changes to the web service resources.
```bash
$ git clone https://github.com/Clivern/terraform-provider-boilerplate.git
# Build the provider
$ make ARGS="terraform-provider-boilerplate" build
// OR
$ go build -o terraform-provider-boilerplate
# Initialize a working directory containing Terraform configuration files
$ terraform init
# Create an execution plan.
$ terraform plan
# Apply the changes required to reach the desired state of the configuration
$ terraform apply
# Revert changes
$ terraform destroy
```
## General Rules
- Terraform provider should always consume an independent client library or sdk which implements the core logic for communicating with the upstream. You should consider moving the `/sdk` to be a separate project.
- Data sources are a special subset of resources which are read-only. They are resolved earlier than regular resources and can be used as part of Terraform's interpolation.
## Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, terraform-provider-boilerplate is maintained under the [Semantic Versioning guidelines](https://semver.org/) and release process is predictable and business-friendly.
See the [Releases section of our GitHub project](https://github.com/Clivern/terraform-provider-boilerplate/releases) for changelogs for each release version of terraform-provider-boilerplate. It contains summaries of the most noteworthy changes made in each release.
## Bug tracker
If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/Clivern/terraform-provider-boilerplate/issues
## Security Issues
If you discover a security vulnerability within terraform-provider-boilerplate, please send an email to [[email protected]](mailto:[email protected])
## Contributing
We are an open source, community-driven project so please feel free to join us. see the [contributing guidelines](CONTRIBUTING.md) for more details.
## License
© 2019, Clivern. Released under [MIT License](https://opensource.org/licenses/mit-license.php).
**terraform-provider-boilerplate** is authored and maintained by [@Clivern](http://github.com/Clivern).