diff --git a/README.md b/README.md index 41f3f9c..f880b18 100644 --- a/README.md +++ b/README.md @@ -295,7 +295,7 @@ 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. @@ -303,11 +303,11 @@ 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"` @@ -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 diff --git a/pkg/gltform/gltform.go b/pkg/gltform/gltform.go index 4bf6d00..ff36b2b 100644 --- a/pkg/gltform/gltform.go +++ b/pkg/gltform/gltform.go @@ -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 @@ -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 ""