-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TEP-0089] Add a config map to support SPIRE initialization.
This PR is one among the set of PRs done to implement TEP-0089. This PR has been derived from the larger PRs PR#5715 and PR#4759 by @pxp928 and @lumjjb. This PR has the following changes 1. Modify the feature flag to control non-falsifiability from enable-spire to enforce-nonfalsifiability="spire". This is in accordance to the approved TEP. 2. Add a configmap config-spire to initialize SPIRE. Signed-off-by: jagathprakash <31057312+jagathprakash@users.noreply.github.com>
- Loading branch information
1 parent
963aa40
commit faf549a
Showing
20 changed files
with
398 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # Copyright 2022 The Tekton Authors | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| apiVersion: v1 | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: config-spire | ||
| namespace: tekton-pipelines | ||
| labels: | ||
| app.kubernetes.io/instance: default | ||
| app.kubernetes.io/part-of: tekton-pipelines | ||
| data: | ||
| _example: | | ||
| ################################ | ||
| # # | ||
| # EXAMPLE CONFIGURATION # | ||
| # # | ||
| ################################ | ||
| # This block is not actually functional configuration, | ||
| # but serves to illustrate the available configuration | ||
| # options and document them in a way that is accessible | ||
| # to users that `kubectl edit` this config map. | ||
| # | ||
| # These sample configuration options may be copied out of | ||
| # this example block and unindented to be in the data block | ||
| # to actually change the configuration. | ||
| # | ||
| # spire-trust-domain specifies the SPIRE trust domain to use. | ||
| # spire-trust-domain: "example.org" | ||
| # | ||
| # spire-socket-path specifies the SPIRE agent socket for SPIFFE workload API. | ||
| # spire-socket-path: "unix:///spiffe-workload-api/spire-agent.sock" | ||
| # | ||
| # spire-server-addr specifies the SPIRE server address for workload/node registration. | ||
| # spire-server-addr: "spire-server.spire.svc.cluster.local:8081" | ||
| # | ||
| # spire-node-alias-prefix specifies the SPIRE node alias prefix to use. | ||
| # spire-node-alias-prefix: "/tekton-node/" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| /* | ||
| Copyright 2022 The Tekton Authors | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package config | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
|
|
||
| sc "github.com/tektoncd/pipeline/pkg/spire/config" | ||
| corev1 "k8s.io/api/core/v1" | ||
| ) | ||
|
|
||
| const ( | ||
| // SpireConfigMapName is the name of the trusted resources configmap | ||
| SpireConfigMapName = "config-spire" | ||
|
|
||
| // SpireTrustDomain is the key to extract out the SPIRE trust domain to use | ||
| SpireTrustDomain = "spire-trust-domain" | ||
| // SpireSocketPath is the key to extract out the SPIRE agent socket for SPIFFE workload API | ||
| SpireSocketPath = "spire-socket-path" | ||
| // SpireServerAddr is the key to extract out the SPIRE server address for workload/node registration | ||
| SpireServerAddr = "spire-server-addr" | ||
| // SpireNodeAliasPrefix is the key to extract out the SPIRE node alias prefix to use | ||
| SpireNodeAliasPrefix = "spire-node-alias-prefix" | ||
|
|
||
| // SpireTrustDomainDefault is the default value for the SpireTrustDomain | ||
| SpireTrustDomainDefault = "example.org" | ||
| // SpireSocketPathDefault is the default value for the SpireSocketPath | ||
| SpireSocketPathDefault = "unix:///spiffe-workload-api/spire-agent.sock" | ||
| // SpireServerAddrDefault is the default value for the SpireServerAddr | ||
| SpireServerAddrDefault = "spire-server.spire.svc.cluster.local:8081" | ||
| // SpireNodeAliasPrefixDefault is the default value for the SpireNodeAliasPrefix | ||
| SpireNodeAliasPrefixDefault = "/tekton-node/" | ||
| ) | ||
|
|
||
| // NewSpireConfigFromMap creates a Config from the supplied map | ||
| func NewSpireConfigFromMap(data map[string]string) (*sc.SpireConfig, error) { | ||
| cfg := &sc.SpireConfig{} | ||
| var ok bool | ||
| if cfg.TrustDomain, ok = data[SpireTrustDomain]; !ok { | ||
| cfg.TrustDomain = SpireTrustDomainDefault | ||
| } | ||
| if cfg.SocketPath, ok = data[SpireSocketPath]; !ok { | ||
| cfg.SocketPath = SpireSocketPathDefault | ||
| } | ||
| if cfg.ServerAddr, ok = data[SpireServerAddr]; !ok { | ||
| cfg.ServerAddr = SpireServerAddrDefault | ||
| } | ||
| if cfg.NodeAliasPrefix, ok = data[SpireNodeAliasPrefix]; !ok { | ||
| cfg.NodeAliasPrefix = SpireNodeAliasPrefixDefault | ||
| } | ||
| if err := cfg.Validate(); err != nil { | ||
| return nil, fmt.Errorf("failed to parse SPIRE configmap: %w", err) | ||
| } | ||
| return cfg, nil | ||
| } | ||
|
|
||
| // NewSpireConfigFromConfigMap creates a Config from the supplied ConfigMap | ||
| func NewSpireConfigFromConfigMap(configMap *corev1.ConfigMap) (*sc.SpireConfig, error) { | ||
| return NewSpireConfigFromMap(configMap.Data) | ||
| } | ||
|
|
||
| // GetSpireConfigName returns the name of Spire ConfigMap | ||
| func GetSpireConfigName() string { | ||
| if e := os.Getenv("CONFIG_SPIRE"); e != "" { | ||
| return e | ||
| } | ||
| return SpireConfigMapName | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /* | ||
| Copyright 2021 The Tekton Authors | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package config_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/google/go-cmp/cmp" | ||
| "github.com/tektoncd/pipeline/pkg/apis/config" | ||
| test "github.com/tektoncd/pipeline/pkg/reconciler/testing" | ||
| sc "github.com/tektoncd/pipeline/pkg/spire/config" | ||
| "github.com/tektoncd/pipeline/test/diff" | ||
| ) | ||
|
|
||
| func TestNewSpireConfigFromConfigMap(t *testing.T) { | ||
| type testCase struct { | ||
| want *sc.SpireConfig | ||
| fileName string | ||
| } | ||
|
|
||
| testCases := []testCase{ | ||
| { | ||
| want: &sc.SpireConfig{ | ||
| TrustDomain: "test.com", | ||
| SocketPath: "unix:///test-spire-api/test-spire-agent.sock", | ||
| ServerAddr: "test-spire-server.spire.svc.cluster.local:8081", | ||
| NodeAliasPrefix: "/test-tekton-node/", | ||
| }, | ||
| fileName: config.GetSpireConfigName(), | ||
| }, | ||
| { | ||
| want: &sc.SpireConfig{ | ||
| TrustDomain: "example.org", | ||
| SocketPath: "unix:///spiffe-workload-api/spire-agent.sock", | ||
| ServerAddr: "spire-server.spire.svc.cluster.local:8081", | ||
| NodeAliasPrefix: "/tekton-node/", | ||
| }, | ||
| fileName: "config-spire-empty", | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| verifyConfigFileWithExpectedSpireConfig(t, tc.fileName, tc.want) | ||
| } | ||
| } | ||
|
|
||
| func verifyConfigFileWithExpectedSpireConfig(t *testing.T, fileName string, want *sc.SpireConfig) { | ||
| t.Helper() | ||
| cm := test.ConfigMapFromTestFile(t, fileName) | ||
| if got, err := config.NewSpireConfigFromConfigMap(cm); err == nil { | ||
| if d := cmp.Diff(got, want); d != "" { | ||
| t.Errorf("Diff:\n%s", diff.PrintWantGot(d)) | ||
| } | ||
| } else { | ||
| t.Errorf("NewSpireConfigFromConfigMap(actual) = %v", err) | ||
| } | ||
| } |
Oops, something went wrong.