Move etcd certs from examples to fixtures (#41971)

These certs are test data, not an example meant for others to use. In addition, update the README to clarify this. Closes gravitational/teleport-private#1497
gravitational · May 23, 2024 · 345be73 · 345be73
1 parent b5f46c5
commit 345be73
Show file tree

Hide file tree

Showing 17 changed files with 17 additions and 15 deletions.
diff --git a/.github/services/Dockerfile.etcd b/.github/services/Dockerfile.etcd
@@ -3,7 +3,7 @@ ARG ETCD_VERSION
 
 FROM bitnami/etcd:${ETCD_VERSION}
 
-COPY examples/etcd/certs /certs
+COPY fixtures/etcdcerts /certs
 
 HEALTHCHECK CMD etcdctl --insecure-discovery --endpoint=https://etcd0:2379 --key-file /certs/client-key.pem --cert-file /certs/client-cert.pem --ca-file /certs/ca-cert.pem cluster-health
 

diff --git a/.github/workflows/build-ci-service-images.yaml b/.github/workflows/build-ci-service-images.yaml
@@ -4,7 +4,7 @@ on:
   push:
     paths:
       - .github/services/Dockerfile.*
-      - examples/etcd/certs/*.pem
+      - fixtures/etcdcerts/*.pem
     branches:
       - master
 

diff --git a/examples/etcd/certs/README b/examples/etcd/certs/README
diff --git a/examples/etcd/certs/Makefile → fixtures/etcdcerts/Makefile b/examples/etcd/certs/Makefile → fixtures/etcdcerts/Makefile
diff --git a/fixtures/etcdcerts/README b/fixtures/etcdcerts/README
@@ -0,0 +1,6 @@
+# etcdcerts
+
+This directory contains certificates used for Teleport's etcd integration tests.
+They should not be used for any other workloads.
+
+You can remove the certs with `make clean`, and regenerate them with `make`.
diff --git a/examples/etcd/certs/ca-cert.pem → fixtures/etcdcerts/ca-cert.pem b/examples/etcd/certs/ca-cert.pem → fixtures/etcdcerts/ca-cert.pem
diff --git a/examples/etcd/certs/client-cert.pem → fixtures/etcdcerts/client-cert.pem b/examples/etcd/certs/client-cert.pem → fixtures/etcdcerts/client-cert.pem
diff --git a/examples/etcd/certs/client-key.pem → fixtures/etcdcerts/client-key.pem b/examples/etcd/certs/client-key.pem → fixtures/etcdcerts/client-key.pem
diff --git a/examples/etcd/certs/openssl.cnf → fixtures/etcdcerts/openssl.cnf b/examples/etcd/certs/openssl.cnf → fixtures/etcdcerts/openssl.cnf
diff --git a/examples/etcd/certs/root-ca-cert.pem → fixtures/etcdcerts/root-ca-cert.pem b/examples/etcd/certs/root-ca-cert.pem → fixtures/etcdcerts/root-ca-cert.pem
diff --git a/examples/etcd/certs/root-ca-key.pem → fixtures/etcdcerts/root-ca-key.pem b/examples/etcd/certs/root-ca-key.pem → fixtures/etcdcerts/root-ca-key.pem
diff --git a/examples/etcd/certs/server-cert.pem → fixtures/etcdcerts/server-cert.pem b/examples/etcd/certs/server-cert.pem → fixtures/etcdcerts/server-cert.pem
diff --git a/examples/etcd/certs/server-key.pem → fixtures/etcdcerts/server-key.pem b/examples/etcd/certs/server-key.pem → fixtures/etcdcerts/server-key.pem
diff --git a/examples/etcd/certs/signing-ca-cert.pem → fixtures/etcdcerts/signing-ca-cert.pem b/examples/etcd/certs/signing-ca-cert.pem → fixtures/etcdcerts/signing-ca-cert.pem
diff --git a/examples/etcd/certs/signing-ca-key.pem → fixtures/etcdcerts/signing-ca-key.pem b/examples/etcd/certs/signing-ca-key.pem → fixtures/etcdcerts/signing-ca-key.pem
diff --git a/integration/hsm/hsm_test.go b/integration/hsm/hsm_test.go
@@ -76,9 +76,9 @@ func etcdBackendConfig(t *testing.T) *backend.Config {
 		Params: backend.Params{
 			"peers":         []string{etcdTestEndpoint()},
 			"prefix":        prefix,
-			"tls_key_file":  "../../examples/etcd/certs/client-key.pem",
-			"tls_cert_file": "../../examples/etcd/certs/client-cert.pem",
-			"tls_ca_file":   "../../examples/etcd/certs/ca-cert.pem",
+			"tls_key_file":  "../../fixtures/etcdcerts/client-key.pem",
+			"tls_cert_file": "../../fixtures/etcdcerts/client-cert.pem",
+			"tls_ca_file":   "../../fixtures/etcdcerts/ca-cert.pem",
 		},
 	}
 	t.Cleanup(func() {

diff --git a/lib/backend/etcdbk/etcd_test.go b/lib/backend/etcdbk/etcd_test.go
@@ -50,9 +50,9 @@ func TestMain(m *testing.M) {
 var commonEtcdParams = backend.Params{
 	"peers":         []string{etcdTestEndpoint()},
 	"prefix":        examplePrefix,
-	"tls_key_file":  "../../../examples/etcd/certs/client-key.pem",
-	"tls_cert_file": "../../../examples/etcd/certs/client-cert.pem",
-	"tls_ca_file":   "../../../examples/etcd/certs/ca-cert.pem",
+	"tls_key_file":  "../../../fixtures/etcdcerts/client-key.pem",
+	"tls_cert_file": "../../../fixtures/etcdcerts/client-cert.pem",
+	"tls_ca_file":   "../../../fixtures/etcdcerts/ca-cert.pem",
 }
 
 var commonEtcdOptions = []Option{
@@ -177,9 +177,9 @@ func TestCompareAndSwapOversizedValue(t *testing.T) {
 	bk, err := New(context.Background(), backend.Params{
 		"peers":                          []string{etcdTestEndpoint()},
 		"prefix":                         "/teleport",
-		"tls_key_file":                   "../../../examples/etcd/certs/client-key.pem",
-		"tls_cert_file":                  "../../../examples/etcd/certs/client-cert.pem",
-		"tls_ca_file":                    "../../../examples/etcd/certs/ca-cert.pem",
+		"tls_key_file":                   "../../../fixtures/etcdcerts/client-key.pem",
+		"tls_cert_file":                  "../../../fixtures/etcdcerts/client-cert.pem",
+		"tls_ca_file":                    "../../../fixtures/etcdcerts/ca-cert.pem",
 		"dial_timeout":                   500 * time.Millisecond,
 		"etcd_max_client_msg_size_bytes": maxClientMsgSize,
 	}, commonEtcdOptions...)