allow default system namespace to be overridden using an env var

DEVELOPMENT.md

@@ -118,6 +118,20 @@ kubectl create clusterrolebinding cluster-admin-binding \
   --user="${USER}"
 ```
 
+### Install in custom namespace
+1. To install into a different namespace you will need to modify resources in the `./config` folder
+    - remove all `namespace: tekton` references from all yaml files
+    - delete the `namespace.yaml` [here](https://github.com/knative/build-pipeline/blob/c1500fab83b09edadefb38bb8920a0c837d8f32b/config/100-namespace.yaml)
+    - modify the `subjects.namespace` [here](https://github.com/knative/build-pipeline/blob/c1500fab83b09edadefb38bb8920a0c837d8f32b/config/201-clusterrolebinding.yaml#L21) value to the desired namespace
+    - add `downwardapi` entry to webhook and controller `deployment` resources. E.g. add the environment variable section from the code snippet below to [controller](https://github.com/knative/build-pipeline/blob/c1500fab83b09edadefb38bb8920a0c837d8f32b/config/controller.yaml#L29) and [webhook](https://github.com/knative/build-pipeline/blob/c1500fab83b09edadefb38bb8920a0c837d8f32b/config/webhook.yaml#L32)
+```yaml
+env:
+  - name: SYSTEM_NAMESPACE
+    valueFrom:
+      fieldRef:
+        fieldPath: metadata.namespace
+```
+
 ## Iterating
 
 While iterating on the project, you may need to:

cmd/controller/main.go

@@ -88,7 +88,7 @@ func main() {
 		logger.Fatalf("Error building pipeline clientset: %v", err)
 	}
 
-	configMapWatcher := configmap.NewInformedWatcher(kubeClient, system.Namespace)
+	configMapWatcher := configmap.NewInformedWatcher(kubeClient, system.GetNamespace())
 
 	opt := reconciler.Options{
 		KubeClientSet:     kubeClient,

cmd/webhook/main.go

@@ -64,7 +64,7 @@ func main() {
 		logger.Fatal("Failed to get the client set", zap.Error(err))
 	}
 	// Watch the logging config map and dynamically update logging levels.
-	configMapWatcher := configmap.NewInformedWatcher(kubeClient, system.Namespace)
+	configMapWatcher := configmap.NewInformedWatcher(kubeClient, system.GetNamespace())
 	configMapWatcher.Watch(logging.ConfigName, logging.UpdateLevelFromConfigMap(logger, atomicLevel, logging.WebhookLogKey))
 	if err = configMapWatcher.Start(stopCh); err != nil {
 		logger.Fatalf("failed to start configuration manager: %v", err)
@@ -73,7 +73,7 @@ func main() {
 	options := webhook.ControllerOptions{
 		ServiceName:    "tekton-pipelines-webhook",
 		DeploymentName: "tekton-pipelines-webhook",
-		Namespace:      system.Namespace,
+		Namespace:      system.GetNamespace(),
 		Port:           443,
 		SecretName:     "webhook-certs",
 		WebhookName:    "webhook.tekton.dev",

pkg/artifacts/artifact_storage_test.go

@@ -40,7 +40,7 @@ func TestInitializeArtifactStorageWithConfigMap(t *testing.T) {
 		desc: "valid bucket",
 		configMap: &corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
-				Namespace: system.Namespace,
+				Namespace: system.GetNamespace(),
 				Name:      v1alpha1.BucketConfigName,
 			},
 			Data: map[string]string{
@@ -68,7 +68,7 @@ func TestInitializeArtifactStorageWithConfigMap(t *testing.T) {
 		desc: "location empty",
 		configMap: &corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
-				Namespace: system.Namespace,
+				Namespace: system.GetNamespace(),
 				Name:      v1alpha1.BucketConfigName,
 			},
 			Data: map[string]string{
@@ -91,7 +91,7 @@ func TestInitializeArtifactStorageWithConfigMap(t *testing.T) {
 		desc: "missing location",
 		configMap: &corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
-				Namespace: system.Namespace,
+				Namespace: system.GetNamespace(),
 				Name:      v1alpha1.BucketConfigName,
 			},
 			Data: map[string]string{
@@ -113,7 +113,7 @@ func TestInitializeArtifactStorageWithConfigMap(t *testing.T) {
 		desc: "no config map data",
 		configMap: &corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
-				Namespace: system.Namespace,
+				Namespace: system.GetNamespace(),
 				Name:      v1alpha1.BucketConfigName,
 			},
 		},
@@ -131,7 +131,7 @@ func TestInitializeArtifactStorageWithConfigMap(t *testing.T) {
 		desc: "no secret",
 		configMap: &corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
-				Namespace: system.Namespace,
+				Namespace: system.GetNamespace(),
 				Name:      v1alpha1.BucketConfigName,
 			},
 			Data: map[string]string{
@@ -200,7 +200,7 @@ func TestGetArtifactStorageWithConfigMap(t *testing.T) {
 		desc: "valid bucket",
 		configMap: &corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
-				Namespace: system.Namespace,
+				Namespace: system.GetNamespace(),
 				Name:      v1alpha1.BucketConfigName,
 			},
 			Data: map[string]string{
@@ -221,7 +221,7 @@ func TestGetArtifactStorageWithConfigMap(t *testing.T) {
 		desc: "location empty",
 		configMap: &corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
-				Namespace: system.Namespace,
+				Namespace: system.GetNamespace(),
 				Name:      v1alpha1.BucketConfigName,
 			},
 			Data: map[string]string{
@@ -235,7 +235,7 @@ func TestGetArtifactStorageWithConfigMap(t *testing.T) {
 		desc: "missing location",
 		configMap: &corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
-				Namespace: system.Namespace,
+				Namespace: system.GetNamespace(),
 				Name:      v1alpha1.BucketConfigName,
 			},
 			Data: map[string]string{
@@ -248,7 +248,7 @@ func TestGetArtifactStorageWithConfigMap(t *testing.T) {
 		desc: "no config map data",
 		configMap: &corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
-				Namespace: system.Namespace,
+				Namespace: system.GetNamespace(),
 				Name:      v1alpha1.BucketConfigName,
 			},
 		},

pkg/artifacts/artifacts_storage.go

@@ -43,7 +43,7 @@ type ArtifactStorageInterface interface {
 // InitializeArtifactStorage will check if there is there is a
 // bucket configured or create a PVC
 func InitializeArtifactStorage(pr *v1alpha1.PipelineRun, c kubernetes.Interface, logger *zap.SugaredLogger) (ArtifactStorageInterface, error) {
-	configMap, err := c.CoreV1().ConfigMaps(system.Namespace).Get(v1alpha1.BucketConfigName, metav1.GetOptions{})
+	configMap, err := c.CoreV1().ConfigMaps(system.GetNamespace()).Get(v1alpha1.BucketConfigName, metav1.GetOptions{})
 	shouldCreatePVC, err := needsPVC(configMap, err, logger)
 	if err != nil {
 		return nil, err
@@ -87,7 +87,7 @@ func needsPVC(configMap *corev1.ConfigMap, err error, logger *zap.SugaredLogger)
 // GetArtifactStorage returns the storage interface to enable
 // consumer code to get a container step for copy to/from storage
 func GetArtifactStorage(prName string, c kubernetes.Interface, logger *zap.SugaredLogger) (ArtifactStorageInterface, error) {
-	configMap, err := c.CoreV1().ConfigMaps(system.Namespace).Get(v1alpha1.BucketConfigName, metav1.GetOptions{})
+	configMap, err := c.CoreV1().ConfigMaps(system.GetNamespace()).Get(v1alpha1.BucketConfigName, metav1.GetOptions{})
 	pvc, err := needsPVC(configMap, err, logger)
 	if err != nil {
 		return nil, err

pkg/reconciler/v1alpha1/pipelinerun/pipelinerun_test.go

@@ -50,7 +50,7 @@ func getRunName(pr *v1alpha1.PipelineRun) string {
 func getPipelineRunController(d test.Data, recorder record.EventRecorder) test.TestAssets {
 	c, i := test.SeedTestData(d)
 	observer, logs := observer.New(zap.InfoLevel)
-	configMapWatcher := configmap.NewInformedWatcher(c.Kube, system.Namespace)
+	configMapWatcher := configmap.NewInformedWatcher(c.Kube, system.GetNamespace())
 	return test.TestAssets{
 		Controller: NewController(
 			reconciler.Options{

pkg/reconciler/v1alpha1/taskrun/config/entrypoint_test.go

@@ -40,7 +40,7 @@ func TestEntrypointConfiguration(t *testing.T) {
 		},
 		config: &corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
-				Namespace: system.Namespace,
+				Namespace: system.GetNamespace(),
 				Name:      EntrypointConfigName,
 			},
 			Data: map[string]string{
@@ -53,7 +53,7 @@ func TestEntrypointConfiguration(t *testing.T) {
 		},
 		config: &corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
-				Namespace: system.Namespace,
+				Namespace: system.GetNamespace(),
 				Name:      EntrypointConfigName,
 			},
 			Data: map[string]string{},
@@ -65,7 +65,7 @@ func TestEntrypointConfiguration(t *testing.T) {
 			},
 			config: &corev1.ConfigMap{
 				ObjectMeta: metav1.ObjectMeta{
-					Namespace: system.Namespace,
+					Namespace: system.GetNamespace(),
 					Name:      EntrypointConfigName,
 				},
 			}},

pkg/reconciler/v1alpha1/taskrun/taskrun_test.go

@@ -142,7 +142,7 @@ func getRunName(tr *v1alpha1.TaskRun) string {
 func getTaskRunController(d test.Data) test.TestAssets {
 	c, i := test.SeedTestData(d)
 	observer, logs := observer.New(zap.InfoLevel)
-	configMapWatcher := configmap.NewInformedWatcher(c.Kube, system.Namespace)
+	configMapWatcher := configmap.NewInformedWatcher(c.Kube, system.GetNamespace())
 	return test.TestAssets{
 		Controller: NewController(
 			reconciler.Options{

pkg/system/names.go

@@ -16,9 +16,19 @@ limitations under the License.
 
 package system
 
+import "os"
+
 const (
-	// Namespace holds the K8s namespace where our build-pipeline system
-	// components run.
-	Namespace    = "tekton-pipelines"
-	PipelineKind = "Pipeline"
+	DefaultNamespace      = "tekton-pipelines"
+	SystemNamespaceEnvVar = "SYSTEM_NAMESPACE"
 )
+
+// GetNamespace holds the K8s namespace where our build-pipeline system
+// components run.
+func GetNamespace() string {
+	systemNamespace := os.Getenv(SystemNamespaceEnvVar)
+	if systemNamespace == "" {
+		return DefaultNamespace
+	}
+	return os.Getenv(SystemNamespaceEnvVar)
+}