Skip to content

Commit b6d1fd7

Browse files
committed
docs: rename repository references to new component name
1 parent ce902be commit b6d1fd7

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Zinit [![Rust](https://github.com/threefoldtech/zinit/actions/workflows/rust.yml/badge.svg)](https://github.com/threefoldtech/zinit/actions/workflows/rust.yml)
1+
# ZOS Init [![Rust](https://github.com/threefoldtech/zinit/actions/workflows/rust.yml/badge.svg)](https://github.com/threefoldtech/zinit/actions/workflows/rust.yml)
22

3-
Zinit is a lightweight PID 1 replacement inspired by runit, written in Rust using Tokio for async I/O. It manages service startup, supervision, and lifecycle, ensuring configured services remain running and handling dependencies through a simple declarative interface.
3+
ZOS Init is a lightweight PID 1 replacement inspired by runit, written in Rust using Tokio for async I/O. It manages service startup, supervision, and lifecycle, ensuring configured services remain running and handling dependencies through a simple declarative interface.
44

55
## What this is
66

7-
Zinit is an init system and process supervisor designed for environments that need reliable service management without the complexity of traditional init systems. It runs as PID 1 or in container mode, monitors configured services, restarts them on failure, and respects dependency ordering during startup and shutdown. Zinit exposes both a Unix socket control interface and an HTTP proxy with a JSON-RPC 2.0 API.
7+
ZOS Init is an init system and process supervisor designed for environments that need reliable service management without the complexity of traditional init systems. It runs as PID 1 or in container mode, monitors configured services, restarts them on failure, and respects dependency ordering during startup and shutdown. ZOS Init exposes both a Unix socket control interface and an HTTP proxy with a JSON-RPC 2.0 API.
88

99
## What this repository contains
1010

@@ -18,11 +18,11 @@ Zinit is an init system and process supervisor designed for environments that ne
1818

1919
## Role in the stack
2020

21-
Zinit serves as the init system for ZOS / Zero-OS nodes and can also be used as a standalone process manager in containers or lightweight Linux systems. It is the layer that ensures system services (networking, storage, provisioning, and user workloads) are started in the correct order and kept healthy. External tools and clients — including the Zinit Client Rust library — can interact with it over its socket or HTTP APIs.
21+
ZOS Init serves as the init system for ZOS / Zero-OS nodes and can also be used as a standalone process manager in containers or lightweight Linux systems. It is the layer that ensures system services (networking, storage, provisioning, and user workloads) are started in the correct order and kept healthy. External tools and clients — including the ZOS Init Client Rust library — can interact with it over its socket or HTTP APIs.
2222

2323
## ZOS / Zero-OS
2424

25-
ZOS, also known as Zero-OS, is the operating system layer used to run and manage nodes. It provides the low-level runtime environment for workloads, networking, storage, and automation. Zinit is the init system at the core of ZOS, responsible for bootstrapping and supervising all node services.
25+
ZOS, also known as Zero-OS, is the operating system layer used to run and manage nodes. It provides the low-level runtime environment for workloads, networking, storage, and automation. ZOS Init is the init system at the core of ZOS, responsible for bootstrapping and supervising all node services.
2626

2727
## Relation to ThreeFold
2828

@@ -41,7 +41,7 @@ curl https://raw.githubusercontent.com/threefoldtech/zinit/refs/heads/master/ins
4141
curl https://raw.githubusercontent.com/threefoldtech/zinit/refs/heads/master/install_run.sh | bash
4242
```
4343

44-
Click [here](docs/installation.md) for more information on how to install Zinit.
44+
Click [here](docs/installation.md) for more information on how to install ZOS Init.
4545

4646
## Usage
4747

@@ -70,7 +70,7 @@ More information about all the available commands can be found [here](docs/cmd.m
7070

7171
### Service Configuration
7272

73-
Zinit uses YAML files for service configuration. Here's a basic example:
73+
ZOS Init uses YAML files for service configuration. Here's a basic example:
7474

7575
```yaml
7676
# Service configuration (e.g., /etc/zinit/myservice.yaml)
@@ -86,13 +86,13 @@ For more information on how to configure service files, see the [service file re
8686
8787
### JSON-RPC API
8888
89-
The HTTP proxy provides a JSON-RPC 2.0 API for interacting with Zinit. You can send JSON-RPC requests to the HTTP endpoint you provided to the proxy:
89+
The HTTP proxy provides a JSON-RPC 2.0 API for interacting with ZOS Init. You can send JSON-RPC requests to the HTTP endpoint you provided to the proxy:
9090
9191
```bash
9292
curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1,"method":"service_list","params":{}}' http://localhost:8080/
9393
```
9494
95-
See the [OpenRPC specs](openrpc.json) for more information about available RPC calls to interact with Zinit.
95+
See the [OpenRPC specs](openrpc.json) for more information about available RPC calls to interact with ZOS Init.
9696
9797
## License
9898

0 commit comments

Comments
 (0)