https://github.com/storageos/init
Init container to prepare the environment for StorageOS
https://github.com/storageos/init
Last synced: 5 months ago
JSON representation
Init container to prepare the environment for StorageOS
- Host: GitHub
- URL: https://github.com/storageos/init
- Owner: storageos
- License: mit
- Created: 2018-05-23T13:49:57.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-16T10:02:08.000Z (over 3 years ago)
- Last Synced: 2025-08-15T11:50:02.041Z (11 months ago)
- Language: Go
- Homepage:
- Size: 23.6 MB
- Stars: 1
- Watchers: 11
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Init Container for StorageOS
[](https://github.com/storageos/init/actions?query=workflow%3A%22Test+and+build+image%22) [](https://travis-ci.com/storageos/init)
Init container to prepare the environment for StorageOS.
## Options
* `-scripts` - absolute path of the scripts directory.
* `-nodeImage` - StorageOS Node container image that the init container runs along. This should be used when running out of k8s.
* `-dsName` - StorageOS k8s DaemonSet name. Use when running within a k8s cluster.
* `-dsNamespace` - StorageOS k8s DaemonSet namespace. Use when running within a k8s cluster.
## Environment Variables
* `NODE_IMAGE` - StorageOS Node container image.
* `DAEMONSET_NAME` - StorageOS DaemonSet name.
* `DAEMONSET_NAMESPACE` - StorageOS DaemonSet namespace.
## Test
```console
make test
```
## Build
```console
make docker-build IMAGE=storageos/init:test
```
## Release
The version must be set in the `Dockerfile`. To set it, run:
```console
NEW_VERSION= make release
```
## Run it on host
Build the init container with `make docker-build` and run it on the host with
`make run`.
Pass a StorageOS Node image and scripts directory as:
```console
make run SCRIPTS_PATH=scripts/ NODE_IMAGE=storageos/node:1.4.0
```
## Script Framework
The script framework executes a set of scripts, performing any checks and
running the necessary script based on the host environment. The script's stdout
and stderr are written to the stdout and stderr of the init app. Container logs
should show all the logs of the individual scripts that ran. The exit status of
the scripts are used to determine initialization failure or success. Any
non-zero exit status are also logged as an event in the k8s pod events.
The scripts should be placed in the `scripts/` dir. The scripts are sorted for
execution based on their name and their parent directory name in lexical order.
The scripts must start with shebang (`#!/bin/bash` for bash scripts) and must
have executable permission(`chmod +x`).
Example scripts dir:
```console
scripts
├── 01-script.sh
├── 05-foo
│ └── scriptx.sh
│ └── README.md
├── 07-scriptz.sh
└── 10-baz
└── scripty.sh
└── README.md
```
In the above example, the script execution order will be
```console
01-script.sh, scriptx.sh, 07-scriptz.sh, scripty.sh
```
For documenting each script, they can be placed in a subdirectory along with a
markdown(.md) or a text file(.txt). These docs files are ignored.