fixing documentation and typos

Author: justonedev1

control-operator/README.md

@@ -1,63 +1,76 @@
 # operator
-// TODO(user): Add simple overview of use/purpose
+
+Folder with operators regarding Task and Environment deployment.
 
 ## Description
-// TODO(user): An in-depth paragraph about your project and overview of use
+
+In order to deploy Task and Environment workflows to the k8s cluster you need controllers and operators
+controlling custom CRDs defining ALICE custom workload. This Folder defines and implements all moving parts together with Makefile
+to build, deploy, install CRDs and operators.
 
 ## Getting Started
-You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
-**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
+
+You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. Author had the most success with K3s [see](/docs/kubernetes_ecs.md).
+**Note:** Your controller will automatically use the current context in your kubeconfig (usually ~/.kube/config) file (i.e. whatever cluster `kubectl cluster-info` shows).
 
 ### Running on the cluster
+
+Following commands show basic use of Makefile. However this isn't exhaustive list.
+
 1. Install Instances of Custom Resources:
 
 ```sh
 kubectl apply -f config/samples/
 ```
 
-2. Build and push your image to the location specified by `IMG`:
+1. Build and push your image to the location specified by `IMG`:
 
 ```sh
 make docker-build docker-push IMG=<some-registry>/operator:tag
 ```
 
-3. Deploy the controller to the cluster with the image specified by `IMG`:
+1. Deploy the controller to the cluster with the image specified by `IMG`:
 
 ```sh
 make deploy IMG=<some-registry>/operator:tag
 ```
 
 ### Uninstall CRDs
+
 To delete the CRDs from the cluster:
 
 ```sh
 make uninstall
 ```
 
 ### Undeploy controller
+
 UnDeploy the controller from the cluster:
 
 ```sh
 make undeploy
 ```
 
 ## Contributing
+
 // TODO(user): Add detailed information on how you would like others to contribute to this project
 
 ### How it works
+
 This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).
 
 It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/),
 which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.
 
 ### Test It Out
+
 1. Install the CRDs into the cluster:
 
 ```sh
 make install
 ```
 
-2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
+1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
 
 ```sh
 make run
@@ -66,6 +79,7 @@ make run
 **NOTE:** You can also run this in one step by running: `make install run`
 
 ### Modifying the API definitions
+
 If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
 
 ```sh
@@ -91,4 +105,3 @@ 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.
-

docs/kubernetes_ecs.md

@@ -23,6 +23,12 @@ is ability to run Pods with privileged permissions and also under user `flp`.
 This means that the machine has to have `flp` user setup the same way as
 if you would do the installation with [`o2-flp-setup`](https://alice-flp.docs.cern.ch/Operations/Experts/system-configuration/utils/o2-flp-setup/).
 
+## Task Controller
+
+Following text assumes that there is a Task Controller from `control-operator` running
+at your K8s cluster and Task CRD installed at your cluster.
+You can find the details about the usage in the [documentation](/control-operator/README.md).
+
 ## Running tasks (`KubectlTask`)
 
 ECS is setup to run tasks through Mesos on all required hosts baremetal with active
@@ -62,7 +68,7 @@ inside the `ControlWorkflows` directory. Namely:
 
 * add path to the kubectl manifest as the first argument in `.command.arguments` field
 * change `.control.mode` to either `kubectl_direct` or `kubectl_fairmq`
-You can find working template inside `control-operator/ecs-manifests/control-workflows/*_kube.yaml`
+You can find working template inside `control-operator/ecs-manifests/control-workflows/*-kube.yaml`
 
 Working kubectl manifests are to be found in `control-operator/ecs-manifests/kubernetes-manifests`.
 You can see `*test.yaml` for concrete deployable manifests by `kubectl apply`, the rest

executor/executable/kubectltask.go

@@ -179,7 +179,7 @@ func (task *KubectlTask) Launch() error {
 		}
 		supplementalString := "[" + strings.Join(strIds, ", ") + "]"
 
-		os.Setenv("FLP_SUPPLEMENTAL_GORUPS", supplementalString)
+		os.Setenv("FLP_SUPPLEMENTAL_GROUPS", supplementalString)
 	} else {
 		log.Error("we cannot run kubectl task as flp user because we didn't find user details")
 	}
@@ -212,7 +212,7 @@ func (task *KubectlTask) Launch() error {
 		log.WithFields(logrus.Fields{
 			"controlmode": task.Tci.ControlMode,
 			"name":        task.ti.Name,
-		}).WithError(err).Errorf("kubectl apply failed stderr: %s , stdin: %s", stderrBuf.String(), stdoutBuf.String())
+		}).WithError(err).Errorf("kubectl apply failed stderr: %s , stdout: %s", stderrBuf.String(), stdoutBuf.String())
 		return err
 	}