From: Todd Malsbary <todd.malsbary@intel.com>
Date: Fri, 11 Mar 2022 00:46:13 +0000 (-0800)
Subject: Expand software BOM
X-Git-Url: https://gerrit.akraino.org/r/gitweb?a=commitdiff_plain;h=1708ea9f0a1963a87d2b959ba7fa80f24fbd8d84;p=icn.git

Expand software BOM

Signed-off-by: Todd Malsbary <todd.malsbary@intel.com>
Change-Id: I7b8009f4297cc13f897d53fca675668978038998
---

diff --git a/doc/software-bom.md b/doc/software-bom.md
index 33ac57d..25dff6a 100644
--- a/doc/software-bom.md
+++ b/doc/software-bom.md
@@ -4,39 +4,42 @@
 
 ## Jump server
 
-|Component|Version|
-|---|---|
-|OS|Ubuntu 20.04|
-|K8s|v1.20.7 (Kubespray 2.16.0)|
-|Docker|19.03 (Kubespray 2.16.0)|
-|Flannel|v0.13.0 (Kubespray 2.16.0)|
-|Ironic|capm3-v0.5.4|
-|cert-manager|v1.7.1|
-|Bare Metal Operator|capm3-v0.5.4|
-|Cluster API|v0.4.7|
-|Flux|0.27.0|
+|Component|Link|Version|License|
+|---|---|---|---|
+|OS|https://ubuntu.com/|Ubuntu 20.04|GPL-2.0|
+|Kubespray|https://github.com/kubernetes-sigs/kubespray|2.16.0|Apache-2.0|
+|K8s|https://kubernetes.io/|v1.20.7|Apache-2.0|
+|Docker|https://www.docker.com/|19.03|Apache-2.0|
+|Flannel|https://github.com/flannel-io/flannel|v0.13.0|Apache-2.0|
+|Ironic|https://github.com/metal3-io/baremetal-operator|capm3-v0.5.4|Apache-2.0|
+|cert-manager|https://cert-manager.io/|v1.7.1|Apache-2.0|
+|Bare Metal Operator|https://github.com/metal3-io/baremetal-operator|capm3-v0.5.4|Apache-2.0|
+|Cluster API|https://cluster-api.sigs.k8s.io/|v0.4.7|Apache-2.0|
+|Flux|https://fluxcd.io/|0.27.0|Apache-2.0|
 
 ## Compute cluster
 
-|Component|Version|
-|---|---|
-|OS|Ubuntu 20.04|
-|K8s|v1.21.6|
-|containerd|1.4.11-1|
-|Calico|v3.22.0|
-|Containerized Data Importer|v1.44.1|
-|cert-manager|v1.7.1|
-|CPU Manager for Kubernetes|v1.4.1|
-|EMCO|v21.12|
-|Flux|0.27.0|
-|Intel Network Adapter Virtual Function Driver Installer|latest|
-|Istio|1.10.3|
-|Kata Containers|2.3.2|
-|KubeVirt|v0.50.0|
-|Multus|v3.8|
-|Node Feature Discovery|v0.10.1|
-|Nodus|dd9985e5be010b764b324b57c1afe985a59abf68|
-|Intel QAT Device Plugin|v0.23.0|
-|Intel QAT Driver Installer|latest|
-|SR-IOV Network Operator|v1.1.0|
+|Component|Link|Version|License|
+|---|---|---|---|
+|OS|https://ubuntu.com/|Ubuntu 20.04|GPL-2.0
+|K8s|https://kubernetes.io/|v1.21.6|Apache-2.0|
+|containerd|https://containerd.io/|1.4.11-1|Apache-2.0|
+|Calico|https://www.tigera.io/project-calico/|v3.22.0|Apache-2.0|
+|Containerized Data Importer|https://github.com/kubevirt/containerized-data-importer|v1.44.1|Apache-2.0|
+|cert-manager|https://cert-manager.io/|v1.7.1|Apache-2.0|
+|CPU Manager for Kubernetes|https://github.com/intel/CPU-Manager-for-Kubernetes|v1.4.1|Apache-2.0|
+|EMCO|https://gitlab.com/project-emco|v21.12|Apache-2.0|
+|Flux|https://fluxcd.io/|0.27.0|Apache-2.0|
+|Intel Network Adapter Linux Virtual Function Driver for Intel Ethernet Controller 700 and E810 Series|https://www.intel.com/content/www/us/en/download/18159/intel-network-adapter-linux-virtual-function-driver-for-intel-ethernet-controller-700-and-e810-series.html|4.0.2|GPL-2.0|
+|Intel Network Adapter Virtual Function Driver Installer|https://gerrit.onap.org/r/#/admin/projects/multicloud/k8s|latest|Apache-2.0|
+|Istio|https://istio.io/|1.10.3|Apache-2.0|
+|Kata Containers|https://katacontainers.io/|2.3.2|Apache-2.0|
+|KubeVirt|https://kubevirt.io/|v0.50.0|Apache-2.0|
+|Multus|https://github.com/k8snetworkplumbingwg/multus-cni|v3.8|Apache-2.0|
+|Node Feature Discovery|https://github.com/kubernetes-sigs/node-feature-discovery|v0.10.1|Apache-2.0|
+|Nodus|https://gerrit.akraino.org/r/admin/repos/icn/nodus|dd9985e5be010b764b324b57c1afe985a59abf68|Apache-2.0|
+|Intel QAT Driver for Linux for Intel Server Boards and Systems Based on Intel 62X Chipset|https://www.intel.com/content/www/us/en/download/19081/intel-quickassist-technology-intel-qat-driver-for-linux-for-intel-server-boards-and-systems-based-on-intel-62x-chipset.html|1.7.l.4.12.0-00011|GPL-2.0,BSD,OpenSSL,ZLib|
+|Intel QAT Device Plugin|https://github.com/intel/intel-device-plugins-for-kubernetes|v0.23.0|Apache-2.0|
+|Intel QAT Driver Installer|https://gerrit.onap.org/r/#/admin/projects/multicloud/k8s|latest|Apache-2.0|
+|SR-IOV Network Operator|https://github.com/k8snetworkplumbingwg/sriov-network-operator|v1.1.0|Apache-2.0|
 
diff --git a/tools/software-bom.sh b/tools/software-bom.sh
index f39d535..4dbaef0 100755
--- a/tools/software-bom.sh
+++ b/tools/software-bom.sh
@@ -9,46 +9,55 @@ source $LIBDIR/common.sh
 
 function table_header {
     cat <<EOF
-|Component|Version|
-|---|---|
+|Component|Link|Version|License|
+|---|---|---|---|
 EOF
 }
 
 function jump_server_os {
     case $(awk '/m.vm.box = / {print $3}' ${ICNDIR}/Vagrantfile | tr -d "'") in
-	"intergratedcloudnative/ubuntu2004") version="Ubuntu 20.04" ;;
-	*) version="UNKNOWN" ;;
+	"intergratedcloudnative/ubuntu2004")
+	    link="https://ubuntu.com/"
+	    version="Ubuntu 20.04"
+	    license="GPL-2.0"
+	    ;;
+	*)
+	    link="UNKNOWN"
+	    version="UNKNOWN"
+	    license="UNKNOWN"
+	    ;;
     esac
-    echo "|OS|${version}|"
+    echo "|OS|${link}|${version}|${license}|"
 }
 
 function kubespray_version {
     awk -F= '/KUBESPRAY_VERSION=/ {print $2}' ${ICNDIR}/deploy/kud/kud_bm_launch.sh
 }
- 
+
 function jump_server_k8s {
     local -r version=$(curl -sL https://raw.githubusercontent.com/kubernetes-sigs/kubespray/v$(kubespray_version)/roles/kubespray-defaults/defaults/main.yaml | awk '/kube_version:/ {print $2}')
-    echo "|K8s|${version} (Kubespray $(kubespray_version))|"
+    echo "|Kubespray|https://github.com/kubernetes-sigs/kubespray|$(kubespray_version)|Apache-2.0|"
+    echo "|K8s|https://kubernetes.io/|${version}|Apache-2.0|"
 }
 
 function jump_server_cri {
     local -r version=$(curl -sL https://raw.githubusercontent.com/kubernetes-sigs/kubespray/v$(kubespray_version)/roles/container-engine/docker/defaults/main.yml | awk '/docker_version:/ {print $2}' | tr -d "'")
-    echo "|Docker|${version} (Kubespray $(kubespray_version))|"
+    echo "|Docker|https://www.docker.com/|${version}|Apache-2.0|"
 }
 
 function jump_server_cni {
     # kud/hosting_providers/vagrant/inventory/group_vars/k8s-cluster.yml:kube_network_plugin: flannel
     local -r version=$(curl -sL https://raw.githubusercontent.com/kubernetes-sigs/kubespray/v$(kubespray_version)/roles/download/defaults/main.yml | awk '/flannel_version:/ {print $2}' | tr -d '"')
-    echo "|Flannel|${version} (Kubespray $(kubespray_version))|"
+    echo "|Flannel|https://github.com/flannel-io/flannel|${version}|Apache-2.0|"
 }
 
 function jump_server_addons {
     cat <<EOF
-|Ironic|${BMO_VERSION}|
-|cert-manager|${CERT_MANAGER_VERSION}|
-|Bare Metal Operator|${BMO_VERSION}|
-|Cluster API|${CAPI_VERSION}|
-|Flux|${FLUX_VERSION}|
+|Ironic|https://github.com/metal3-io/baremetal-operator|${BMO_VERSION}|Apache-2.0|
+|cert-manager|https://cert-manager.io/|${CERT_MANAGER_VERSION}|Apache-2.0|
+|Bare Metal Operator|https://github.com/metal3-io/baremetal-operator|${BMO_VERSION}|Apache-2.0|
+|Cluster API|https://cluster-api.sigs.k8s.io/|${CAPI_VERSION}|Apache-2.0|
+|Flux|https://fluxcd.io/|${FLUX_VERSION}|Apache-2.0|
 EOF
 }
 
@@ -63,24 +72,32 @@ function jump_server {
 
 function compute_cluster_os {
     case $(awk '/imageName:/ {print $2}' ${ICNDIR}/deploy/cluster/values.yaml) in
-	"focal-server-cloudimg-amd64.img") version="Ubuntu 20.04" ;;
-	*) version="UNKNOWN" ;;
+	"focal-server-cloudimg-amd64.img")
+	    link="https://ubuntu.com/"
+	    version="Ubuntu 20.04"
+	    license="GPL-2.0"
+	    ;;
+	*)
+	    link="UNKNOWN"
+	    version="UNKNOWN"
+	    license="UNKNOWN"
+	    ;;
     esac
-    echo "|OS|${version}|"
+    echo "|OS|${link}|${version}|${license}"
 }
 
 function compute_cluster_k8s {
     local -r version=$(awk '/k8sVersion:/ {print $2}' ${ICNDIR}/deploy/cluster/values.yaml)
-    echo "|K8s|${version}|"
+    echo "|K8s|https://kubernetes.io/|${version}|Apache-2.0|"
 }
 
 function compute_cluster_cri {
     local -r version=$(awk '/containerdVersion:/ {print $2}' ${ICNDIR}/deploy/cluster/values.yaml)
-    echo "|containerd|${version}|"
+    echo "|containerd|https://containerd.io/|${version}|Apache-2.0|"
 }
 
 function compute_cluster_cni {
-    echo "|Calico|${CALICO_VERSION}|"
+    echo "|Calico|https://www.tigera.io/project-calico/|${CALICO_VERSION}|Apache-2.0|"
 }
 
 function git_repository_tag {
@@ -91,7 +108,7 @@ function git_repository_tag {
 function image_tag {
     local -r source_yaml=$1
     local -r image_name=$2
-    awk -F: '/image:.*'"${image_name}"'/ {print $3}' ${source_yaml} | tr -d '"' 
+    awk -F: '/image:.*'"${image_name}"'/ {print $3}' ${source_yaml} | tr -d '"'
 }
 
 function ref_tag {
@@ -99,23 +116,35 @@ function ref_tag {
     awk -F= '/?ref=/ {print $2}' ${kustomization_yaml} | tr -d "'"
 }
 
+function iavf_driver_version {
+    eval $(curl -sL https://raw.githubusercontent.com/onap/multicloud-k8s/${KUD_VERSION}/kud/deployment_infra/installers/entrypoint-iavf-driver-installer.sh | awk '/IAVF_DRIVER_VERSION/ {print; exit}')
+    echo ${IAVF_DRIVER_VERSION}
+}
+
+function qat_driver_version {
+    eval $(curl -sL https://raw.githubusercontent.com/onap/multicloud-k8s/${KUD_VERSION}/kud/deployment_infra/installers/entrypoint-qat-driver-installer.sh | awk '/QAT_DRIVER_VERSION/ {print; exit}')
+    echo ${QAT_DRIVER_VERSION}
+}
+
 function compute_cluster_addons {
     cat <<EOF
-|Containerized Data Importer|${CDI_VERSION}|
-|cert-manager|${CERT_MANAGER_VERSION}|
-|CPU Manager for Kubernetes|${CPU_MANAGER_VERSION}|
-|EMCO|$(git_repository_tag ${ICNDIR}/deploy/site/cluster-emco-management/emco-source.yaml)|
-|Flux|${FLUX_VERSION}|
-|Intel Network Adapter Virtual Function Driver Installer|$(image_tag ${ICNDIR}/deploy/iavf-driver-installer/icn/daemonset.yaml iavf-driver-installer)|
-|Istio|$(git_repository_tag ${ICNDIR}/deploy/site/cluster-addons/istio-source.yaml)|
-|Kata Containers|${KATA_VERSION}|
-|KubeVirt|${KUBEVIRT_VERSION}|
-|Multus|${MULTUS_VERSION}|
-|Node Feature Discovery|$(ref_tag ${ICNDIR}/deploy/node-feature-discovery/icn/kustomization.yaml)|
-|Nodus|${NODUS_VERSION}|
-|Intel QAT Device Plugin|${QAT_VERSION}|
-|Intel QAT Driver Installer|$(image_tag ${ICNDIR}/deploy/qat-driver-installer/icn/daemonset.yaml qat-driver-installer)|
-|SR-IOV Network Operator|$(git_repository_tag ${ICNDIR}/deploy/sriov-network-operator/icn/source.yaml)|
+|Containerized Data Importer|https://github.com/kubevirt/containerized-data-importer|${CDI_VERSION}|Apache-2.0|
+|cert-manager|https://cert-manager.io/|${CERT_MANAGER_VERSION}|Apache-2.0|
+|CPU Manager for Kubernetes|https://github.com/intel/CPU-Manager-for-Kubernetes|${CPU_MANAGER_VERSION}|Apache-2.0|
+|EMCO|https://gitlab.com/project-emco|$(git_repository_tag ${ICNDIR}/deploy/site/cluster-emco-management/emco-source.yaml)|Apache-2.0|
+|Flux|https://fluxcd.io/|${FLUX_VERSION}|Apache-2.0|
+|Intel Network Adapter Linux Virtual Function Driver for Intel Ethernet Controller 700 and E810 Series|https://www.intel.com/content/www/us/en/download/18159/intel-network-adapter-linux-virtual-function-driver-for-intel-ethernet-controller-700-and-e810-series.html|$(iavf_driver_version)|GPL-2.0|
+|Intel Network Adapter Virtual Function Driver Installer|https://gerrit.onap.org/r/#/admin/projects/multicloud/k8s|$(image_tag ${ICNDIR}/deploy/iavf-driver-installer/icn/daemonset.yaml iavf-driver-installer)|Apache-2.0|
+|Istio|https://istio.io/|$(git_repository_tag ${ICNDIR}/deploy/site/cluster-addons/istio-source.yaml)|Apache-2.0|
+|Kata Containers|https://katacontainers.io/|${KATA_VERSION}|Apache-2.0|
+|KubeVirt|https://kubevirt.io/|${KUBEVIRT_VERSION}|Apache-2.0|
+|Multus|https://github.com/k8snetworkplumbingwg/multus-cni|${MULTUS_VERSION}|Apache-2.0|
+|Node Feature Discovery|https://github.com/kubernetes-sigs/node-feature-discovery|$(ref_tag ${ICNDIR}/deploy/node-feature-discovery/icn/kustomization.yaml)|Apache-2.0|
+|Nodus|https://gerrit.akraino.org/r/admin/repos/icn/nodus|${NODUS_VERSION}|Apache-2.0|
+|Intel QAT Driver for Linux for Intel Server Boards and Systems Based on Intel 62X Chipset|https://www.intel.com/content/www/us/en/download/19081/intel-quickassist-technology-intel-qat-driver-for-linux-for-intel-server-boards-and-systems-based-on-intel-62x-chipset.html|$(qat_driver_version)|GPL-2.0,BSD,OpenSSL,ZLib|
+|Intel QAT Device Plugin|https://github.com/intel/intel-device-plugins-for-kubernetes|${QAT_VERSION}|Apache-2.0|
+|Intel QAT Driver Installer|https://gerrit.onap.org/r/#/admin/projects/multicloud/k8s|$(image_tag ${ICNDIR}/deploy/qat-driver-installer/icn/daemonset.yaml qat-driver-installer)|Apache-2.0|
+|SR-IOV Network Operator|https://github.com/k8snetworkplumbingwg/sriov-network-operator|$(git_repository_tag ${ICNDIR}/deploy/sriov-network-operator/icn/source.yaml)|Apache-2.0|
 EOF
 }