Enable BCS pod launcher POC with docker/k8s mode (#26)

The BCS Pod Launcher is a tool designed to start a Media Proxy Agent instance on one machine and MCM Media Proxy instances on each machine. It enables the initiation of the BCS ffmpeg pipeline with a bound NMOS client node application.
The tool can operate in two modes:

Kubernetes Mode: For multi-node cluster deployment.
Docker Mode: For single-node deployment using Docker containers.

Added core for controllers - for docker and kubernetes mode
Added manifests for kubernetes
Defined input file for k8s mode
Add instructions to run in README
Added prototyped core for BCS pod (and containers) launcher.
Extending to containers support:

Decouple functionality of docker and k8s mode
Reorganize file with configuration
Add silent MCM installation
Note that resources have not been completely configured.
This poc only covers flow and algorithms in bcs launcher

Author: Magda-Pytel

launcher/.dockerignore

@@ -0,0 +1,9 @@
+# 
+# SPDX-FileCopyrightText: Copyright (c) 2024 Intel Corporation
+# 
+# SPDX-License-Identifier: BSD-3-Clause
+# 
+
+# More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file
+# Ignore build and test binaries.
+bin/

launcher/.gitignore

@@ -0,0 +1,33 @@
+# 
+# SPDX-FileCopyrightText: Copyright (c) 2024 Intel Corporation
+# 
+# SPDX-License-Identifier: BSD-3-Clause
+# 
+
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+bin/*
+Dockerfile.cross
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Go workspace file
+go.work
+
+# Kubernetes Generated files - skip generated files, except for vendored files
+!vendor/**/zz_generated.*
+
+# editor and IDE paraphernalia
+.idea
+.vscode
+*.swp
+*.swo
+*~

launcher/Dockerfile

@@ -0,0 +1,47 @@
+# Copyright 2024.
+# 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.
+ 
+# SPDX-FileCopyrightText: Copyright (c) 2024 Intel Corporation
+# 
+# SPDX-License-Identifier: BSD-3-Clause
+
+# Build the manager binary
+FROM golang:1.23 AS builder
+ARG TARGETOS
+ARG TARGETARCH
+
+WORKDIR /workspace
+# Copy the Go Modules manifests
+COPY go.mod go.mod
+COPY go.sum go.sum
+RUN go mod download
+
+# Copy the go source
+COPY cmd/main.go cmd/main.go
+COPY api/ api/
+COPY internal/ internal/
+COPY resources_library/ resources_library/
+
+# Build
+# the GOARCH has not a default value to allow the binary be built according to the host where the command
+# was called. 
+RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager cmd/main.go
+
+# # Use distroless as minimal base image to package the manager binary
+# # Refer to https://github.com/GoogleContainerTools/distroless for more details
+FROM gcr.io/distroless/static:nonroot
+WORKDIR /
+COPY --from=builder /workspace/manager .
+USER 65532:65532
+
+HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 CMD [ "curl", "-f", "http://localhost:8081/healthz" ] || exit 1
+
+ENTRYPOINT ["/manager"]

launcher/PROJECT

@@ -0,0 +1,35 @@
+# Copyright 2024.
+# 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.
+
+
+# SPDX-FileCopyrightText: Copyright (c) 2024 Intel Corporation
+# 
+# SPDX-License-Identifier: BSD-3-Clause
+
+domain: bcs.intel
+layout:
+- go.kubebuilder.io/v4
+plugins:
+  manifests.sdk.operatorframework.io/v2: {}
+  scorecard.sdk.operatorframework.io/v2: {}
+projectName: bcs-launcher
+repo: bcs.pod.launcher.intel
+resources:
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: bcs.intel
+  group: bcs
+  kind: BcsConfig
+  path: bcs.pod.launcher.intel/api/v1
+  version: v1
+version: "3"

launcher/README.md

@@ -0,0 +1,99 @@
+# BCS pod launcher
+
+BCS pod launcher starts once Media Proxy Agent instance (on one machine) and MCM Media Proxy instances on each machine. It enables to starts BCS ffmpeg pipeline with bound NMOS client node application.
+
+## Description
+
+The tool can operate in two modes:
+
+- Kubernetes Mode: For multi-node cluster deployment.
+- Docker Mode: For single-node using Docker containers.
+
+**Flow (Common to Both Modes)**
+
+1. Run MediaProxy Agent
+2. Run MCM Media Proxy
+3. Run BcsFfmpeg pipeline with NMOS
+
+In case of docker, MediaProxy/MCM things should only start/run once and on every run of launcher, one should start the app according to input file. It does not store the state of apps, just check appropriate conditions.
+
+In case of kuberenetes, MediaProxy/MCM things should only be run once and BCS pod launcher works as operator in the understanding of Kuberenetes operators within pod. That is way, input file in this way is CustomReaource called BcsConfig.
+
+## Getting Started
+
+### Prerequisites
+
+- go version v1.22.0+
+- docker version 17.03+.
+- kubectl version v1.27+
+- Access to a Kubernetes v1.11.3+ cluster.
+
+### To Run containers on single node  
+
+```bash
+# currently only in dev phase
+cd <repo>/launcher/cmd/
+# Adjust to your needs: ./configuration_files/bcslauncher-static-config.yaml
+go run main.go
+
+```
+
+### To Deploy on the cluster
+
+**Build image:**  
+Modify `./launcher/configuration_files/bcslauncher-static-config.yaml`. `k8s: false` defines docker (containers on single host) mode.  
+`docker build -t controller:bcs_pod_launcher .`
+
+**BCS pod launcher installer in k8s cluster:**  
+
+Users can just run kubectl apply -f <file> to install the project:
+
+```bash
+cd <repo>/launcher/
+kubectl apply -f ./configuration_files/bcslauncher-k8s-config.yaml
+kubectl apply -f ./configuration_files/bcsconfig-crd.yaml
+kubectl apply -f ./configuration_files/bcs-launcher.yaml
+# Adjust to your needs: ./configuration_files/bcsconfig-example.yaml
+kubectl apply -f ./configuration_files/bcsconfig-example.yaml
+
+```
+
+**BCS pod launcher roles of files in k8s cluster:**  
+
+- `configuration_files/bcslauncher-k8s-config.yaml` -> configmap for setting up the mode of launcher. `k8s: true` defines kuberenets mode. Currently, you should not modify this in that file.
+- `configuration_files/bcs-launcher.yaml` -> install set of kuberenetes resources that are needed to run bcs pod luancher, no additional configuration required
+- `configuration_files/bcsconfig-crd.yaml` -> Custom Resource Definition for `BcsConfig`  
+- `configuration_files/bcsconfig-example.yaml` -> example `BcsConfig` file that it is an input to provide information about **bcs ffmpeg piepeline and NMOS client**, you can adjust file to your needs,
+- `configuration_files/bcslauncher-static-config.yaml` -> static config for docker mode. `k8s: false` defines docker mode. Currently, you should not modify this in that file.
+
+**BCS pod launcher deletion of implementationn of BCS pod launcher in k8s cluster:**  
+
+```bash
+cd <repo>/launcher/
+kubectl delete -f ./configuration_files/bcslauncher-k8s-config.yaml
+kubectl delete -f ./configuration_files/bcsconfig-crd.yaml
+kubectl delete -f ./configuration_files/bcs-launcher.yaml
+kubectl delete -f ./configuration_files/bcsconfig-example.yaml
+```
+
+## License
+
+SPDX-FileCopyrightText: Copyright (c) 2024 Intel Corporation
+
+SPDX-License-Identifier: BSD-3-Clause
+
+===============================================================
+
+Copyright 2024.
+
+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.

launcher/api/v1/bcsconfig_types.go

@@ -0,0 +1,86 @@
+/*
+Copyright 2024.
+
+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.
+*/
+
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2024 Intel Corporation
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+package v1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// BcsConfigSpec defines the desired state of BcsConfig
+type BcsConfigSpec struct {
+	AppParams   AppParams   `json:"appParams"`
+	Connections Connections `json:"connections"`
+}
+
+type AppParams struct {
+	UniqueName  string `json:"uniqueName"`
+	Codec       string `json:"codec"`
+	PixelFormat string `json:"pixelFormat"`
+	Height      int    `json:"height"`
+	Width       int    `json:"width"`
+}
+
+type Connections struct {
+	DataConnection    DataConnection    `json:"dataConnection"`
+	ControlConnection ControlConnection `json:"controlConnection"`
+}
+
+type DataConnection struct {
+	ConnType            string `json:"connType"`
+	MediaProxyIpAddress string `json:"mediaProxyIpAddress"`
+	Port                int    `json:"port"`
+}
+
+type ControlConnection struct {
+	IpAddress string `json:"ipAddress"`
+	Port      int    `json:"port"`
+}
+
+// BcsConfigStatus defines the observed state of BcsConfig
+type BcsConfigStatus struct {
+}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+
+// BcsConfig is the Schema for the bcsconfigs API
+type BcsConfig struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   BcsConfigSpec   `json:"spec,omitempty"`
+	Status BcsConfigStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// BcsConfigList contains a list of BcsConfig
+type BcsConfigList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []BcsConfig `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&BcsConfig{}, &BcsConfigList{})
+}

launcher/api/v1/groupversion_info.go

@@ -0,0 +1,42 @@
+/*
+Copyright 2024.
+
+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.
+*/
+
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2024 Intel Corporation
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+// Package v1 contains API Schema definitions for the bcs v1 API group
+// +kubebuilder:object:generate=true
+// +groupName=bcs.bcs.intel
+package v1
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"sigs.k8s.io/controller-runtime/pkg/scheme"
+)
+
+var (
+	// GroupVersion is group version used to register these objects
+	GroupVersion = schema.GroupVersion{Group: "bcs.bcs.intel", Version: "v1"}
+
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
+
+	// AddToScheme adds the types in this group-version to the given scheme.
+	AddToScheme = SchemeBuilder.AddToScheme
+)