https://github.com/stackrox/automation-standard
🤖 A micro-framework for building standardized cluster automation entrypoints
https://github.com/stackrox/automation-standard
Last synced: 6 months ago
JSON representation
🤖 A micro-framework for building standardized cluster automation entrypoints
- Host: GitHub
- URL: https://github.com/stackrox/automation-standard
- Owner: stackrox
- License: apache-2.0
- Created: 2019-12-19T22:43:03.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-02T18:02:21.000Z (over 3 years ago)
- Last Synced: 2025-03-02T17:25:25.380Z (11 months ago)
- Language: Go
- Size: 32.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Automation Standard
🤖 A micro-framework for building standardized cluster automation entrypoints
## Installing
You can fetch this library by running the following:
```bash
$ go get -u github.com/stackrox/automation-standard
```
## Motivations
Given that there is a need for various cluster automations (GKE, OpenShift, Istio, KOPS, etc), standardizing on how those automations are configured is beneficial.
Additionally, integrating these automations into hard-to-debug-systems leads to things failing in strange ways because they were partially or misconfigured.
This library is opinionated, explicit, and strict as an effort to eliminate as many unknowns across these service boundaries as possible.
## Usage
```go
package main
import (
"context"
"fmt"
standard "github.com/stackrox/automation-standard"
)
func main() {
cfg := standard.Application{
Name: "example",
Description: "Automation Standard example application",
Homepage: "https://github.com/stackrox/automation-standard",
Version: "v0.0.0",
Create: standard.Action{
Inputs: []standard.Parameter{
{
Name: "GOOGLE_APPLICATION_CREDENTIALS",
Description: "Location of GCP service account credential file",
Source: standard.Environment,
},
{
Name: "main-image",
Description: "Main image tag",
Source: standard.Flag,
},
},
Handler: create,
},
Destroy: standard.Action{
Inputs: []standard.Parameter{
{
Name: "GOOGLE_APPLICATION_CREDENTIALS",
Description: "Location of GCP service account credential file",
Source: standard.Environment,
},
},
Handler: destroy,
},
}
standard.Run(cfg)
}
func create(ctx context.Context, parameters map[string]string) error {
fmt.Println("Hello from create()")
fmt.Printf("Deploying %s\n", parameters["main-image"])
return nil
}
func destroy(ctx context.Context, parameters map[string]string) error {
fmt.Println("Hello from destroy()")
return nil
}
```