Errand: Naming standards, Deployment of the containers, Dependency and Readiness

Author: qdnqn

docs/definitions/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Definitions",
-  "position": 4,
+  "position": 5,
   "link": {
     "type": "generated-index",
     "description": "Learn what resources are available."

docs/deployment/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Container deployment",
-  "position": 3,
+  "position": 4,
   "link": {
     "type": "generated-index",
     "description": "Learn how to deploy container and other resources."

docs/deployment/plain.md

@@ -2,4 +2,114 @@
 sidebar_position: 5
 ---
 
-# Plain
+# Containers deployment
+## Minimal deployment
+To deploy container with minimal configuration, definition below is enough:
+```cgo
+prefix: simplecontainer.io/v1
+kind: containers
+meta:
+  group: example
+  name: busybox
+spec:
+  image: busybox
+  tag: latest
+  replicas: 1
+  entrypoint: ["sleep"]
+  args: ["3600"]
+```
+Entrypoint and args are additional configuration so that container keeps alive.
+
+```bash
+smrctl apply  https://raw.githubusercontent.com/simplecontainer/examples/refs/heads/main/tests/minimal/definitions/Containers.yaml
+```
+This deploys busybox container.
+
+## Readiness and dependency
+
+Database is often used as the dependency for other services. This can easily be achieved.
+
+```cgo
+kind: containers
+prefix: simplecontainer.io/v1
+meta:
+  name: mysql
+  group: mysql
+spec:
+  image: "mysql"
+  tag: "8.0"
+  replicas: 1
+  spread:
+    spread: uniform
+  envs:
+    - MYSQL_ROOT_PASSWORD=(( .password ))
+    - CONTAINER_NAME=(( .testing ))
+  ports:
+    - container: "3306"
+  volumes:
+    - type: bind
+      hostPath: /tmp
+      mountPoint: /tmp
+  configurations:
+    - group: mysql
+      name: config
+  resources:
+    - group: mysql
+      name: config
+      key: my.cnf
+      mountPoint: /etc/my.cnf
+    - group: mysql
+      name: config
+      key: secret.config.file
+      mountPoint: /etc/secret.cnf
+  readiness:
+    - name: "mysql"
+      timeout: "60s"
+      command: ["mysqladmin", "ping", "-h", "localhost", "-p(( .password ))"]
+  configuration:
+    username: "root"
+    password: (( lookup "secret/mysql/password:password" | base64decode ))
+    testing: (( lookup "runtime/container/configuration:name" ))
+    testing2: (( lookup "runtime/container/configuration:name" ))
+    secret: "secret"
+```
+
+To create another container that depends on the database, definition:
+
+```cgo
+kind: containers
+prefix: simplecontainer.io/v1
+meta:
+  name: nginx
+  group: nginx
+  labels:
+    test: testing2345
+spec:
+  image: "nginx"
+  tag: "1.23.3"
+  replicas: 2
+  dependencies:
+    - prefix: "simplecontainer.io/v1"
+      group: "mysql"
+      name: "*"
+      timeout: "30s"
+  ports:
+    - container: "80"
+    - container: "443"
+  resources:
+    - group: nginx
+      name: config
+      key: nginx-configuration
+      mountPoint: /etc/nginx/conf.d/default.conf
+  configuration:
+    username: "root"
+```
+
+Dependencies relies on the group and name to match. Container/s that is/are referenced in the dependency needs to have it's 
+own readiness completed successfully so that container will mark dependency as ready.
+
+By default, as soon as the container is running readiness is successful.
+
+Since container can have more replicas the wildcard `*` can be used in the name to wait for all container replicas.
+
+Otherwise, it can be configured to match only specific instance using generated name eg. `mysql-mysql-1`. This follows naming convention.

docs/installation/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Running nodes",
-  "position": 2,
+  "position": 3,
   "link": {
     "type": "generated-index",
     "description": "Learn how to deploy simplecontainer nodes whether single node or multiple nodes."

docs/installation/debugging.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 5
 ---
 
 # Debugging startup issues
@@ -14,13 +14,22 @@ The command above needs to run as the user who is not root and has correct acces
 ## Docker socket access is not correctly configured
 Simplecontainer relies on the `/var/run/docker.sock` to communicate with the docker engine.
 
+:::warning
+When changing ownership of the socket, security aspect needs to be taken into consideration.
+:::
+
 ### Option 1: Make user owner of the socket (Temporary solution)
 ```cgo
 sudo chown $USER /var/run/docker.sock
 ```
+This will change the ownership for the `docker.sock` for the current session and will allow communication to it. 
+Reboot will clear permissions and this needs to be done again.
 
 ### Option 2: Add user to the group that has access to the /var/run/docker.sock (Permanent solution)
 ```cgo
 GROUP_NAME=$(stat -c '%G' /var/run/docker.sock)
 sudo usermod -aG "$GROUP_NAME" "$USER"
-```
+```
+Assiging current user to the group, that has permissions `docker.sock`, will survive reboots and will enable access of the 
+current user to the `docker.sock`. When starting simplecontainer node container - all group user has will be appended to the 
+container itself and will solve all permission issues over socket.

docs/installation/prerequisites.md

@@ -36,10 +36,6 @@ In the background it relies on the `smrctl` and `smr` CLI and exposes to the use
 
 To install smrmgr run the snippet below (it will install, under /usr/local/bin, both smr and smrctl).
 
-:::warning
-These commands must be run as non-root user otherwise the deployment will fail.
-:::
-
 ```bash
 curl -sL https://smrmgr.simplecontainer.io -o smrmgr
 chmod +x smrmgr

docs/installation/running-cluster.md

@@ -23,6 +23,10 @@ This scenario assumes there are two nodes (virtual machines) connected over inte
 
 First step is to start simplecontainer for the node 1.
 
+:::warning
+The command smrmgr start must be run as non-root user otherwise the deployment will fail.
+:::
+
 ```bash
 smrmgr start -n smr-node-1 -d node-1.simplecontainer.io
 ```
@@ -78,6 +82,10 @@ This will import context and fetch certificates from the node it got context fro
 
 Start the simplecontainer for the node 2 and ask to join the cluster with client certificates from node 1.
 
+:::warning
+The command smrmgr start must be run as non-root user otherwise the deployment will fail.
+:::
+
 ```cgo
 smrmgr start -n smr-node-2 -d node-2.simplecontainer.io -j -p https://node-1.simplecontainer.io:1443
 ```

docs/installation/running-localhost.md

@@ -14,6 +14,10 @@ First check all prerequisites!
 
 It is simple and easy.
 
+:::warning
+The command smrmgr start must be run as non-root user otherwise the deployment will fail.
+:::
+
 ```cgo
 smrmgr start -n smr-node-1 -c "--port.control 127.0.0.1:1443 --port.overlay 127.0.0.1:9212"
 smrctl context import $(smr agent export --node smr-node-1) -y

docs/installation/running-single.md

@@ -17,6 +17,10 @@ First check prerequisites!
 
 To run single node of simplecontainer on the machine run the snippet below.
 
+:::warning
+The command smrmgr start must be run as non-root user otherwise the deployment will fail.
+:::
+
 ```bash text title="Starting simplecontainer node with control plane exposed on the smr.example.com"
 smrmgr start -n smr-node-1 -d node.simplecontainer.io
 ```

docs/naming/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Naming",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Naming conventions and standards."
+  }
+}