clean up docs and add more license headers

Signed-off-by: Paolo Dettori <[email protected]>
kubestellar · May 17, 2024 · d47c82b · d47c82b
1 parent 2f7897d
commit d47c82b
Show file tree

Hide file tree

Showing 52 changed files with 292 additions and 667 deletions.
diff --git a/clustermetrics/Makefile b/clustermetrics/Makefile
@@ -1,3 +1,17 @@
+# Copyright 2024 The KubeStellar 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.
+
 # Image URL to use all building/pushing image targets
 KO_DOCKER_REPO ?= ko.local
 IMAGE_TAG ?= $(shell git rev-parse --short HEAD)

diff --git a/clustermetrics/README.md b/clustermetrics/README.md
@@ -1,5 +1,6 @@
 # clustermetrics
-// TODO(user): Add simple overview of use/purpose
+
+Provides per-node metrics for clusters to support multi-cluster scheduling decisions.
 
 ## Description
 // TODO(user): An in-depth paragraph about your project and overview of use

diff --git a/clustermetrics/internal/controller/clustermetrics_controller.go b/clustermetrics/internal/controller/clustermetrics_controller.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/clustermetrics/internal/controller/clustermetrics_controller_test.go b/clustermetrics/internal/controller/clustermetrics_controller_test.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/clustermetrics/internal/controller/suite_test.go b/clustermetrics/internal/controller/suite_test.go
@@ -1,19 +1,18 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar 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
+	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 controller
 
 import (

diff --git a/clustermetrics/test/e2e/e2e_suite_test.go b/clustermetrics/test/e2e/e2e_suite_test.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/clustermetrics/test/e2e/e2e_test.go b/clustermetrics/test/e2e/e2e_test.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/clustermetrics/test/utils/utils.go b/clustermetrics/test/utils/utils.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/mc-scheduling/Makefile b/mc-scheduling/Makefile
@@ -1,3 +1,17 @@
+# Copyright 2024 The KubeStellar 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.
+
 # Image URL to use all building/pushing image targets
 KO_DOCKER_REPO ?= ko.local
 IMAGE_TAG ?= $(shell git rev-parse --short HEAD)

diff --git a/mc-scheduling/README.md b/mc-scheduling/README.md
@@ -1,5 +1,6 @@
 # mc-scheduling
-// TODO(user): Add simple overview of use/purpose
+
+Multi-cluster scheduling framework supporting pluggable schedulers.
 
 ## Description
 // TODO(user): An in-depth paragraph about your project and overview of use

diff --git a/mc-scheduling/cmd/mc-scheduler/main.go b/mc-scheduling/cmd/mc-scheduler/main.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/mc-scheduling/internal/controller/suite_test.go b/mc-scheduling/internal/controller/suite_test.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/mc-scheduling/internal/controller/workflow_controller.go b/mc-scheduling/internal/controller/workflow_controller.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/mc-scheduling/internal/controller/workflow_controller_test.go b/mc-scheduling/internal/controller/workflow_controller_test.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/mc-scheduling/pkg/scheduler/default_scheduler.go b/mc-scheduling/pkg/scheduler/default_scheduler.go
@@ -1,3 +1,19 @@
+/*
+Copyright 2024 The KubeStellar 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 scheduler
 
 import (

diff --git a/mc-scheduling/pkg/scheduler/scheduler_interface.go b/mc-scheduling/pkg/scheduler/scheduler_interface.go
@@ -1,3 +1,19 @@
+/*
+Copyright 2024 The KubeStellar 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 scheduler
 
 import (

diff --git a/mc-scheduling/test/e2e/e2e_suite_test.go b/mc-scheduling/test/e2e/e2e_suite_test.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/mc-scheduling/test/e2e/e2e_test.go b/mc-scheduling/test/e2e/e2e_test.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/mc-scheduling/test/utils/utils.go b/mc-scheduling/test/utils/utils.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2024.
+Copyright 2024 The KubeStellar Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/scripts/kfp/README.md → scripts/README.md b/scripts/kfp/README.md → scripts/README.md
@@ -3,15 +3,29 @@
 ## Pre-reqs
 
 Make sure you have the same pre-reqs required by [KubeStellar 0.22](https://docs.kubestellar.io/release-0.22.0/direct/pre-reqs/#kubestellar-prerequisites). 
-Make sure also go and make tools are installed. As for kind and docker,
-this setup has been tested with kind v0.22.0 and Rancher Desktop v1.13.1 on macOS apple silicon.
-It has also been tested on a RHEL 9 VM with 64 GB RAM and 16 Cores on [Draco](https://ocp-draco.bx.cloud9.ibm.com).
-See how to setup the VM [here](docs/RHEL-KS-install.md).
+
+Make sure also go and make tools are installed. Note that this setup has been tested only on the 
+following environments:
+
+- MacBook Pro:
+  - Apple M1 Max, 64 GB Memory
+  - MacOS 14.4.1
+  - Rancher Desktop v1.13.1
+  - kind v0.22.0
+- IBM Cloud VM:
+  - 64 GB RAM, 16 Cores
+  - RHEL 9
+  - Docker CE 26.1.1
+  - kind v0.22.0
+
+
+See how to setup the RHEL VM [here](docs/RHEL-KS-install.md).
 
 ## Preparation
 
 Before runnning the scripts, make sure to increase your ulimits and 
-fs.inotify.max_user_watches and fs.inotify.max_user_instances. 
+fs.inotify.max_user_watches and fs.inotify.max_user_instances for the machine
+running the kind clusters. See [these instructions](https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files) for more info.
 
 For Rancher Desktop follow [these instructions](https://docs.rancherdesktop.io/how-to-guides/increasing-open-file-limit).
 and use the following config:
@@ -43,5 +57,5 @@ backs up and delete your default kubeconfig in ~/.kube/config.
 Run the script:
 
 ```shell
-kfp/instal-all.sh
+./instal-all.sh
 ```
diff --git a/scripts/argo-wf/.ks/ocm-transport-plugin b/scripts/argo-wf/.ks/ocm-transport-plugin
diff --git a/scripts/argo-wf/.ks/transport.log b/scripts/argo-wf/.ks/transport.log
diff --git a/scripts/argo-wf/install-all.sh b/scripts/argo-wf/install-all.sh
@@ -1,5 +1,20 @@
 #!/bin/bash
 
+# Copyright 2023 The KubeStellar 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.
+
+
 set -x # echo so that users can understand what is happening
 set -e # exit on error
 

diff --git a/scripts/argo-wf/install-aw.sh b/scripts/argo-wf/install-aw.sh
@@ -1,5 +1,19 @@
 #!/bin/bash
 
+# Copyright 2024 The KubeStellar 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.
+
 set -x # echo so that users can understand what is happening
 set -e # exit on error