Skip to content

Commit

Permalink
Replace bmaas with metal (#26)
Browse files Browse the repository at this point in the history
In this PR we replace the bmaas references with references to metal.
  • Loading branch information
eamonnotoole authored Oct 21, 2021
1 parent ce8bda4 commit 70d942f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,19 +295,19 @@ func NewClientMap(config provider.ConfigData) (map[string]interface{}, diag.Diag
## pkg/gltform

This package provides utilities to read and parse a .gltform file. The .gltform file is primarily used to share
bmaas/Quake information with the bmaas/Quake provider code. It is also used by Genesis tooling to share
metal/Quake information with the metal/Quake provider code. It is also used by Genesis tooling to share
the IAM token with other services (CaaS at the moment). It is TBD if we will persist with the use of the file
as the provider is developed.

The format of the .gltform file is:
```go
// Gljwt - the contents of the .gltform file
type Gljwt struct {
// SpaceName is optional, and is only required for bmaas if we want to create a project
// SpaceName is optional, and is only required for metal if we want to create a project
SpaceName string `yaml:"space_name,omitempty"`
// ProjectID - the bmaas/Quake project ID
// ProjectID - the metal/Quake project ID
ProjectID string `yaml:"project_id"`
// RestURL - the URL to be used for bmaas, at present it refers to a Quake portal URL
// RestURL - the URL to be used for metal, at present it refers to a Quake portal URL
RestURL string `yaml:"rest_url"`
// Token - the GL IAM token
Token string `yaml:"access_token"`
Expand All @@ -316,11 +316,11 @@ type Gljwt struct {

### Use in service provider repos

The only use of this file is with the bmaas/Quake provider code.
The only use of this file is with the metal/Quake provider code.

### Use in hpegl provider

This package is used by the hpegl provider to build a .gltform for use with bmaas.
This package is used by the hpegl provider to build a .gltform for use with metal.

## pkg/provider

Expand Down
8 changes: 4 additions & 4 deletions pkg/gltform/gltform.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ const fileExtension = ".gltform"

// Gljwt - the contents of the .gltform file
type Gljwt struct {
// SpaceName is optional, and is only required for bmaas if we want to create a project
// SpaceName is optional, and is only required for metal if we want to create a project
SpaceName string `yaml:"space_name,omitempty"`
// ProjectID - the bmaas/Quake project ID
// ProjectID - the metal/Quake project ID
ProjectID string `yaml:"project_id"`
// RestURL - the URL to be used for bmaas, at present it refers to a Quake portal URL
// RestURL - the URL to be used for metal, at present it refers to a Quake portal URL
RestURL string `yaml:"rest_url"`
// TODO remove this entry once we've switched quake-client over to using this package
// Token - the GL IAM token
Expand All @@ -44,7 +44,7 @@ func GetGLConfig() (gljwt *Gljwt, err error) {
// WriteGLConfig takes a map[string]interface{} which will normally come from a
// service block in the provider stanza and writes out a .gltform file in the directory
// from which terraform is being run. See the use of this function
// for bmaas in terraform-provider-hpegl.
// for metal in terraform-provider-hpegl.
func WriteGLConfig(d map[string]interface{}) error {
config := &Gljwt{
// If space_name isn't present, we'll just write out ""
Expand Down

0 comments on commit 70d942f

Please sign in to comment.