Skip to content

Add default dptp collection in dockerconfigs in gsm-config.yaml #5136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
psalajova wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add default dptp collection in dockerconfigs in gsm-config.yaml #5136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions cmd/ci-secret-bootstrap/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,38 +457,38 @@ func constructDockerConfigJSONFromVault(client secrets.ReadOnlyClient, dockerCon
}

// constructDockerConfigJSONFromGSM constructs a .dockerconfigjson from GSM secrets cache
func constructDockerConfigJSONFromGSM(secretsCache map[gsmSecretRef]fetchedSecret, registries []api.RegistryAuthData) ([]byte, error) {
func constructDockerConfigJSONFromGSM(secretsCache map[gsmSecretRef]fetchedSecret, registries []api.RegistryAuthData, gsmDPTPCollection string) ([]byte, error) {
auths := make(map[string]secretbootstrap.DockerAuth)

for _, reg := range registries {
authData := secretbootstrap.DockerAuth{}

authRef := gsmSecretRef{
collection: reg.Collection,
collection: gsmDPTPCollection,
group: reg.Group,
field: reg.AuthField,
}
fetchedAuth, exists := secretsCache[authRef]
if !exists {
return nil, fmt.Errorf("auth field '%s' (collection: %s, group: %s) not found in fetched secrets", reg.AuthField, reg.Collection, reg.Group)
return nil, fmt.Errorf("auth field '%s' (collection: %s, group: %s) not found in fetched secrets", reg.AuthField, gsmDPTPCollection, reg.Group)
}
if fetchedAuth.err != nil {
return nil, fmt.Errorf("couldn't get auth field '%s' (collection: %s, group: %s): %w", reg.AuthField, reg.Collection, reg.Group, fetchedAuth.err)
return nil, fmt.Errorf("couldn't get auth field '%s' (collection: %s, group: %s): %w", reg.AuthField, gsmDPTPCollection, reg.Group, fetchedAuth.err)
}
authData.Auth = string(bytes.TrimSpace(fetchedAuth.payload))

if reg.EmailField != "" {
emailRef := gsmSecretRef{
collection: reg.Collection,
collection: gsmDPTPCollection,
group: reg.Group,
field: reg.EmailField,
}
fetchedEmail, exists := secretsCache[emailRef]
if !exists {
return nil, fmt.Errorf("email field '%s' (collection: %s, group: %s) not found in fetched secrets", reg.EmailField, reg.Collection, reg.Group)
return nil, fmt.Errorf("email field '%s' (collection: %s, group: %s) not found in fetched secrets", reg.EmailField, gsmDPTPCollection, reg.Group)
}
if fetchedEmail.err != nil {
return nil, fmt.Errorf("couldn't get email field '%s' (collection: %s, group: %s): %w", reg.EmailField, reg.Collection, reg.Group, fetchedEmail.err)
return nil, fmt.Errorf("couldn't get email field '%s' (collection: %s, group: %s): %w", reg.EmailField, gsmDPTPCollection, reg.Group, fetchedEmail.err)
}
authData.Email = string(fetchedEmail.payload)
}
Expand Down Expand Up @@ -1375,15 +1375,15 @@ func constructSecretsFromGSM(
}
for _, registryEntry := range bundle.DockerConfig.Registries {
s := gsmSecretRef{
collection: registryEntry.Collection,
collection: gsmConfig.DPTPCollection,
group: registryEntry.Group,
field: registryEntry.AuthField,
}
uniqueSecretNames.Insert(s)

if registryEntry.EmailField != "" {
s := gsmSecretRef{
collection: registryEntry.Collection,
collection: gsmConfig.DPTPCollection,
group: registryEntry.Group,
field: registryEntry.EmailField,
}
Expand Down Expand Up @@ -1496,7 +1496,7 @@ func constructSecretsFromGSM(
}

if bundle.DockerConfig != nil {
dockerConfigData, err := constructDockerConfigJSONFromGSM(fetchedGsmSecretsMap, bundle.DockerConfig.Registries)
dockerConfigData, err := constructDockerConfigJSONFromGSM(fetchedGsmSecretsMap, bundle.DockerConfig.Registries, gsmConfig.DPTPCollection)
if err != nil {
logrus.WithError(err).Errorf("skipping bundle %s: failed to construct dockerconfig", bundle.Name)
errs = append(errs, fmt.Errorf("bundle %s: failed to construct dockerconfig: %w", bundle.Name, err))
Expand Down
15 changes: 2 additions & 13 deletions cmd/ci-secret-bootstrap/main_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3841,6 +3841,7 @@ func TestConstructSecretsFromGSM(t *testing.T) {
{
name: "docker config from GSM",
config: api.GSMConfig{
DPTPCollection: "test-infra",
Bundles: []api.GSMBundle{
{
Name: "docker-secret",
Expand All @@ -3856,13 +3857,11 @@ func TestConstructSecretsFromGSM(t *testing.T) {
As: "pull-secret",
Registries: []api.RegistryAuthData{
{
Collection: "test-infra",
Group: "build-farm",
RegistryURL: "registry.ci.openshift.org",
AuthField: "auth-token",
},
{
Collection: "test-infra",
Group: "build-farm",
RegistryURL: "quay.io",
AuthField: "quay-auth",
Expand Down Expand Up @@ -4173,7 +4172,6 @@ func TestConstructDockerConfigJSONFromGSM(t *testing.T) {
},
registries: []api.RegistryAuthData{
{
Collection: "test",
Group: "grp",
RegistryURL: "quay.io",
AuthField: "auth",
Expand All @@ -4189,7 +4187,6 @@ func TestConstructDockerConfigJSONFromGSM(t *testing.T) {
},
registries: []api.RegistryAuthData{
{
Collection: "test",
Group: "grp",
RegistryURL: "quay.io",
AuthField: "auth",
Expand All @@ -4207,13 +4204,11 @@ func TestConstructDockerConfigJSONFromGSM(t *testing.T) {
},
registries: []api.RegistryAuthData{
{
Collection: "test",
Group: "grp",
RegistryURL: "quay.io",
AuthField: "auth1",
},
{
Collection: "test",
Group: "grp",
RegistryURL: "registry.ci.openshift.org",
AuthField: "auth2",
Expand All @@ -4229,7 +4224,6 @@ func TestConstructDockerConfigJSONFromGSM(t *testing.T) {
},
registries: []api.RegistryAuthData{
{
Collection: "test",
Group: "grp",
RegistryURL: "quay.io",
AuthField: "auth",
Expand All @@ -4242,7 +4236,6 @@ func TestConstructDockerConfigJSONFromGSM(t *testing.T) {
secretsCache: map[gsmSecretRef]fetchedSecret{},
registries: []api.RegistryAuthData{
{
Collection: "test",
Group: "grp",
RegistryURL: "quay.io",
AuthField: "missing",
Expand All @@ -4257,7 +4250,6 @@ func TestConstructDockerConfigJSONFromGSM(t *testing.T) {
},
registries: []api.RegistryAuthData{
{
Collection: "test",
Group: "grp",
RegistryURL: "quay.io",
AuthField: "auth",
Expand All @@ -4272,7 +4264,6 @@ func TestConstructDockerConfigJSONFromGSM(t *testing.T) {
},
registries: []api.RegistryAuthData{
{
Collection: "test",
Group: "grp",
RegistryURL: "quay.io",
AuthField: "auth",
Expand All @@ -4289,7 +4280,6 @@ func TestConstructDockerConfigJSONFromGSM(t *testing.T) {
},
registries: []api.RegistryAuthData{
{
Collection: "test",
Group: "grp",
RegistryURL: "quay.io",
AuthField: "auth",
Expand All @@ -4305,7 +4295,6 @@ func TestConstructDockerConfigJSONFromGSM(t *testing.T) {
},
registries: []api.RegistryAuthData{
{
Collection: "test",
Group: "grp",
RegistryURL: "quay.io",
AuthField: "auth",
Expand All @@ -4317,7 +4306,7 @@ func TestConstructDockerConfigJSONFromGSM(t *testing.T) {

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
actual, err := constructDockerConfigJSONFromGSM(tc.secretsCache, tc.registries)
actual, err := constructDockerConfigJSONFromGSM(tc.secretsCache, tc.registries, "test")

if tc.expectedError != "" {
if err == nil {
Expand Down
2 changes: 1 addition & 1 deletion cmd/ci-secret-generator/main_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,7 @@ func TestValidateContexts(t *testing.T) {
Secrets: []secretbootstrap.SecretConfig{{}},
},
gsmConfig: api.GSMConfig{
DPTPCollection: api.DPTPGSMCollection,
Components: map[string][]api.GSMSecretRef{
"some-component": {
{
Expand All @@ -325,7 +326,6 @@ func TestValidateContexts(t *testing.T) {
DockerConfig: &api.DockerConfigSpec{
Registries: []api.RegistryAuthData{
{
Collection: "test-platform",
Group: "build_cluster",
AuthField: "target-dc-field",
RegistryURL: "https://registry.io",
Expand Down
41 changes: 34 additions & 7 deletions pkg/api/gsm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,17 @@ import (
"github.com/openshift/ci-tools/pkg/util/gzip"
)

const (
// DPTPGSMCollection is the default GSM collection for DPTP-managed secrets (dockerconfig items)
DPTPGSMCollection = "test-platform-infra"
)

// GSMConfig is the top-level configuration for GSM-based secrets
type GSMConfig struct {
ClusterGroups map[string][]string `json:"cluster_groups,omitempty"`
Components map[string][]GSMSecretRef `json:"components,omitempty"`
Bundles []GSMBundle `json:"bundles"`
ClusterGroups map[string][]string `json:"cluster_groups,omitempty"`
DPTPCollection string `json:"dptp_collection,omitempty"`
Components map[string][]GSMSecretRef `json:"components,omitempty"`
Bundles []GSMBundle `json:"bundles,omitempty"`
}

// GSMBundle defines a logical group of GSM secrets
Expand Down Expand Up @@ -67,8 +73,8 @@ type DockerConfigSpec struct {
}

// RegistryAuthData specifies registry credentials
// Collection is always DPTPGSMCollection, which matches dptp_collection in the GSM config
type RegistryAuthData struct {
Collection string `json:"collection"`
Group string `json:"group"`
RegistryURL string `json:"registry_url"`
AuthField string `json:"auth_field"`
Expand Down Expand Up @@ -119,6 +125,15 @@ func (c *GSMConfig) UnmarshalJSON(d []byte) error {
func (c *GSMConfig) resolve() error {
var errs []error

if c.DPTPCollection == "" {
for _, bundle := range c.Bundles {
if bundle.DockerConfig != nil {
c.DPTPCollection = DPTPGSMCollection
break
}
}
}

// Expand cluster_groups to concrete cluster names
for bundleIdx := range c.Bundles {
bundle := &c.Bundles[bundleIdx]
Expand Down Expand Up @@ -263,6 +278,21 @@ type bundleKey struct {
func (c *GSMConfig) Validate() error {
var errs []error

// Validate that dptp_collection is set if any bundle uses dockerconfig
hasDockerConfig := false
for _, bundle := range c.Bundles {
if bundle.DockerConfig != nil {
hasDockerConfig = true
break
}
}
if hasDockerConfig && c.DPTPCollection == "" {
errs = append(errs, fmt.Errorf("dptp_collection must be set when bundles use dockerconfig"))
}
if c.DPTPCollection != "" && !gsmvalidation.ValidateCollectionName(c.DPTPCollection) {
errs = append(errs, fmt.Errorf("dptp_collection has invalid collection name: %s", c.DPTPCollection))
}

// Validate components
componentNames := make(map[string]bool)

Expand Down Expand Up @@ -423,9 +453,6 @@ func validateDockerConfig(dc *DockerConfigSpec, bundleIdx int, bundleName string
}

for i, reg := range dc.Registries {
if !gsmvalidation.ValidateCollectionName(reg.Collection) {
errs = append(errs, fmt.Errorf("bundle[%d] %s dockerconfig registry[%d] has invalid collection string", bundleIdx, bundleName, i))
}
if !gsmvalidation.ValidateGroupName(reg.Group) {
errs = append(errs, fmt.Errorf("bundle[%d] %s dockerconfig registry[%d] has invalid group string", bundleIdx, bundleName, i))
}
Expand Down
Loading