Skip to content

Commit 7b16a8c

Browse files
committed
Update README.md
1 parent 7cdc744 commit 7b16a8c

File tree

1 file changed

+10
-36
lines changed

1 file changed

+10
-36
lines changed

README.md

Lines changed: 10 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -7,69 +7,43 @@
77
*Flamingo* is a lightweight contextualization tool that aims to handle
88
initialization of cloud instances.
99

10-
It is meant to be a replacement for [cloud-init] in [Atomic Host], a lightweight
11-
operating system designed to run applications in Docker containers with
12-
orchestration capabilities ([Kubernetes]). It has 3 different
10+
It is meant to be a replacement for [cloud-init] in [Atomic Host], a lightweight
11+
operating system designed to run applications in Docker containers with
12+
orchestration capabilities ([Kubernetes]). It has 3 different
1313
flavors; [Fedora], [RHEL], and [CentOS].
1414

1515
For more details please check [Introducing Flamingo]
1616

1717
# Goals
18-
The aim of this project is to create a fast, documented, extensible
18+
The aim of this project is to create a **fast**, **extensible**, **documented**
1919
tool to use
2020

2121
## Why not use cloud-init?
2222

2323
- In order for an image to be built with cloud-init as its contextualization tool,
2424
it needs to contain the python interpreter, it's dependencies and the dependencies of
2525
cloud-init. It fattens up the image and increases complexity for the distributions.
26-
- Due to the dynamic nature of scripting languages they are slow. In an I/O boud
26+
- Due to the dynamic nature of scripting languages they are slow. In an I/O boud
2727
application this is not a big problem however initializing VM images, is different.
2828
- The documentation is lacking at best. The tests are inadequate and it is a big chunk
2929
of initialization scripts. Making it hard to work with cloud-init as a developer and
3030
maintainer.
3131

3232
## Solution
3333

34-
- Golang excels at building big applications (e.g. distributed computing).
35-
It provides the necessary tooling for the job. It doesn't have long
34+
- Golang excels at building big applications (e.g. distributed computing).
35+
It provides the necessary tooling for the job. It doesn't have long
3636
dependency chains like interpreted languages and it is fast.
3737

3838
- *Flamingo* will essentially be a single binary coupled with all of its
3939
dependencies. In addition, cloud images will be smaller as well.
4040

4141
- Testability, Documentation and Extensibility is heavily emphasized in *Flamingo*.
4242

43-
# Status
44-
*Flamingo* is version **v0.1.0** at the moment.
45-
46-
For the list of features and the planned changes please see the [blog post](http://tmrts.com/post/0.1.0/)
47-
48-
Build images containing *Flamingo* as the default contextualization tool (swapped with `cloud-init`)
49-
will be available soon.
50-
51-
## What has been done
52-
53-
- Docker Test Environment
54-
- User & Password Management
55-
- Running Custom Scripts
56-
- SSH Configuration
57-
- Manage Services at Boot
58-
- Manage and Modify IPtables/Filter Rules
59-
- RESTful Client
60-
61-
## What is being worked on
62-
63-
- Meta-Data
64-
- Cloud-Config
65-
- Config-Drive
66-
- Integration with `systemd`
67-
- Test Images
68-
6943
## Discussions
70-
In the meanwhile if you'd like to share your opinions, learn more,
71-
or contribute please feel free to open an issue, mail to [centos-devel], [atomic],
72-
user-list or come to \#[atomic](irc://irc.freenode.net/#atomic-devel) and \#[centos-devel](irc://irc.freenode.net/#centos-devel) channels to have a chat.
44+
If you'd like to contribute, learn more, or share your opinions
45+
please feel free to open an issue, mail to [centos-devel], [atomic],
46+
user-list or come to [#atomic](irc://irc.freenode.net/#atomic-devel) and [#centos-devel](irc://irc.freenode.net/#centos-devel) irc channels to have a chat.
7347

7448
[Introducing Flamingo]: http://tmrts.com/post/flamingo/
7549
[cloud-init]: http://cloudinit.readthedocs.org/en/latest/

0 commit comments

Comments
 (0)