Skip to content

Commit f5574fa

Browse files
committed
Update starting of the cluster.
1 parent a98d86e commit f5574fa

5 files changed

Lines changed: 51 additions & 39 deletions

File tree

docs/definitions/_category_.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"label": "Definitions",
33
"position": 4,
44
"link": {
5-
"type": "generated-index"
5+
"type": "generated-index",
6+
"description": "Learn what resources are available."
67
}
78
}

docs/deployment/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"position": 3,
44
"link": {
55
"type": "generated-index",
6-
"description": "5 minutes to learn the most important Docusaurus concepts."
6+
"description": "Learn how to deploy container and other resources."
77
}
88
}

docs/installation/_category_.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "Installation",
2+
"label": "Running nodes",
33
"position": 2,
44
"link": {
55
"type": "generated-index",
6-
"description": "5 minutes to learn the most important Docusaurus concepts."
6+
"description": "5 minutes to learn the most important Simplecontainer concepts."
77
}
88
}

docs/installation/running-cluster.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This scenario assumes there are two nodes (virtual machines) connected over inte
2020
First step is to start simplecontainer for the node 1.
2121

2222
```bash
23-
smrmgr start -a smr-node-1 -d node-1.simplecontainer.io
23+
smrmgr start -a smr-agent-1 -d node-1.simplecontainer.io
2424
```
2525

2626
This starts the simplecontainer node and control plane listens on the `0.0.0.0:1443` which means all interfaces,
@@ -30,14 +30,14 @@ Option `-a` is mandatory and is used for specifying name of the node. It must be
3030

3131
Option `-d` specifies that node generates certificates for mTLS which are only valid for the `node-1.simplecontainer.io`.
3232

33-
To connect to this node on another machine there is easy option:
33+
To connect to the nodes, simplecontainer relies on the contexts (think kube config) - there is easy option to export it and share it:
3434

3535
```cgo
3636
smrmgr export <<< https://node-1.simplecontainer.io:1443
37-
cat $HOME/smr/smr/contexts/$(smr context).key
37+
cat $HOME/smr/contexts/$(smr context).key
3838
```
3939

40-
This exports contexts and encrypt it using AES with key specified on the path `$HOME/smr/smr/contexts/$(smr context).key`.
40+
This exports contexts and encrypt it using AES with key specified on the path `$HOME/smr/contexts/$(smr context).key`.
4141

4242
:::warning
4343
Specify correct host, port and include https:// for the control plane endpoint when exporting. If the
@@ -53,22 +53,18 @@ smrmgr import PASTE_OUTPUT <<< PASTE_KEY
5353
```
5454

5555
If the key is not specified it will listen on `stdin` for decryption key.
56-
57-
Import client certificate for the node 1.
58-
59-
```cgo
60-
smr context fetch
61-
```
56+
This will import context and fetch certificates from the node it got context from.
6257

6358
Start the simplecontainer for the node 2 and ask to join the cluster with client certificates from node 1.
6459

6560
```cgo
66-
smrmgr start -a smr-node-2 -d node-2.simplecontainer.io -j node-1.simplecontainer.io:1443
61+
smrmgr start -a smr-agent-2 -d node-2.simplecontainer.io -j -z https://node-1.simplecontainer.io:1443
6762
```
6863

69-
Option `-j` specifies node that will be asked to join the starting node to the cluster - should be the same as the node from
64+
- Option `-j` specifies node that will be asked to join the starting node to the cluster - should be the same as the node from
7065
contexts are imported from.
71-
66+
- Option `-z` specifies URL of the node which we will ask to join the cluster
67+
-
7268
Now control plane should be accessible.
7369

7470
```cgo title="The smr ps command is used to list all containers in the cluster"

docs/simplecontainer.md

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,45 @@ sidebar_position: 1
66
# Simplecontainer
77

88
:::warning
9-
The project is not stable yet.
9+
The project is in alpha version.
1010
:::
1111

1212
See the simplecontainer in action.
1313

1414
<iframe src="https://www.youtube.com/embed/RTu4sj-7qeA?si=cHBtiujoQlMttjJO" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
15-
The simplecontainer manager is designed to ease life for the developers and DevOps engineers running containers on Docker.
16-
17-
The simplecontainer introduces the following:
18-
19-
- Single docker daemon or cluster of docker daemons
20-
- Overlay networking for containers using flannel (encrypted using wireguard by default)
21-
- Integrated DNS server isolated from Docker daemon
22-
- GitOps: deploy containers on Docker using GitOps pattern
23-
- Replication of containers in cluster of Docker daemons
24-
- Reconciliation and tracking the lifecycle of the Docker containers
25-
- Reliable dependency ordering using readiness probes
26-
- Server side templating of the container objects to leverage secrets, configuration, and resources
27-
- Secrets, Configuration and Resources objects for external configuration
28-
- CLI to interact with the simplecontainer
29-
- Fast learning curve - simplicity and deterministic behavior
30-
- UI dashboard for better overview with real-time updates
31-
32-
It runs as container on top of container engine. Currently, docker is only supported engine.
33-
Simplecontainer requires privilleges for the `/var/run/docker.sock` to work properly.
34-
35-
Afterward API is exposed to orchestrate containers using mTLS for authentication and security.
15+
16+
# SimpleContainer
17+
18+
**SimpleContainer** is a tool for orchestrating Docker (currently) containers on a single node or across multiple nodes in a cluster.It runs on top of a container engine and manages all associated resources such as containers and networks. SimpleContainer uses a declarative approach—define containers using YAML files, and it will reconcile the actual state to match the defined state.
19+
20+
## Features
21+
22+
- Support for a single Docker daemon or a cluster of Docker daemons
23+
- Overlay networking for containers using Flannel (encrypted with WireGuard by default)
24+
- An integrated DNS server, isolated from the Docker daemon
25+
- GitOps: deploy containers using the GitOps pattern
26+
- Container replication across a cluster of Docker daemons
27+
- Reconciliation and lifecycle tracking of Docker containers
28+
- Reliable deployment ordering using readiness probes (containers can truly wait for others to become ready)
29+
- SSR of container objects to manage secrets, configuration, and resources
30+
- Support for Secrets, Configuration, and Resource objects for external configuration
31+
- A CLI for interacting with SimpleContainer
32+
- A fast learning curve with simplicity and deterministic behavior
33+
- A UI dashboard providing a near real-time overview and control ([app.simplecontianer.io](https://app.simplecontainer.io)
34+
)
35+
36+
## Requirements
37+
38+
SimpleContainer requires privileges to access `/var/run/docker.sock` in order to function properly.
39+
Its API is exposed using mTLS for maximum security and is forwarded to the UNIX socket.
40+
41+
42+
## Resources
43+
Checkout examples on [https://github.com/simplecontainer/examples](https://github.com/simplecontainer/examples).
44+
45+
You can deploy resources using smr CLI:
46+
- Pack (Something like helm chart - bundle of related resources only thing is that they are SSR)
47+
- definition.yaml
48+
- https://path_to_your_file.tld
49+
50+

0 commit comments

Comments
 (0)