| ... | @@ -8,12 +8,10 @@ |
... | @@ -8,12 +8,10 @@ |
|
|
|
|
|
|
|
### How-to post-install CII services
|
|
### How-to post-install CII services
|
|
|
|
|
|
|
|
Most CII services (not: telemetry and alarms) come as part of the DevEnv installation, however some post-installation set-up is needed before they can be used.
|
|
Most CII services (but e.g. not telemetry or alarms) come as part of the ECOS installation (`dnf install elt-ecos-devel`), however some post-installation set-up is needed before they can be used.
|
|
|
|
|
|
|
|
Post-installation is always necessary when you start working on a newly installed DevEnv host. After an upgrade of the DevEnv on an existing host, post-install may be necessary, too. In these cases, the Release Notes of the DevEnv version will inform you so.
|
|
Post-installation is always necessary when you start working on a newly installed DevEnv host. After an upgrade of the DevEnv on an existing host, post-install may be necessary, too. In these cases, the Release Notes of the DevEnv version will inform you so.
|
|
|
|
|
|
|
|
_Note on DevEnv versions before 3.6_: On older DevEnv versions, you need to download the post-install first. On DevEnv 3.4, first execute this command (as root): `yum -y install elt-ciisrv-postinstall`. On DevEnv 3.5, execute this command (as root): `yum -y update elt-ciisrv-postinstall`
|
|
|
|
|
|
|
|
|
|
To run post-install, execute this command (as root):
|
|
To run post-install, execute this command (as root):
|
|
|
|
|
|
|
|
```plaintext
|
|
```plaintext
|
| ... | @@ -34,20 +32,20 @@ After postinstall, you will want to start the CII services on your host (unless |
... | @@ -34,20 +32,20 @@ After postinstall, you will want to start the CII services on your host (unless |
|
|
|
|
|
|
|
### How-to start/stop CII services
|
|
### How-to start/stop CII services
|
|
|
|
|
|
|
|
The cii-services utility lets you start/stop/monitor the CII services. For some operations, it requires root-privileges, and can be run with `sudo`. If you don't use sudo, it will show a root password prompt when needed.
|
|
The cii-services utility lets you start/stop/monitor the CII services. For some operations, it requires root-privileges, if you don't have sudo or polkit privileges configured, it will show a root password prompt when needed.
|
|
|
|
|
|
|
|
Note: Before using CII services, you or an administrator have to run the CII-post-installation, see [How-to post-install CII services](#how-to-post-install-cii-services)
|
|
Note: Before using CII services, you or an administrator have to run the CII-post-installation, see [How-to post-install CII services](#how-to-post-install-cii-services)
|
|
|
|
|
|
|
|
_status_ This is a feature-centric view, that basically tells you which features you have available. For example, "Blob Values" means that the Distributed File System MinIO (in previous versions: Hadoop) is available for storage of large values and binaries.
|
|
_info_ renders a complete overview over how CII is configured and its status, e.g. it tells you whether the services are running and where they are.
|
|
|
|
|
|
|
|
```plaintext
|
|
```plaintext
|
|
|
$ cii-services status
|
|
$ cii-services info
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
_info_ This is a deployment-centric view that tells you whether the services are running and where they are.
|
|
Note you can limit the output of _info_ by qualifying it further, e.g. to check which services you have available, run:
|
|
|
|
|
|
|
|
```plaintext
|
|
```plaintext
|
|
|
$ cii-services info
|
|
$ cii-services info function
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
_start / stop_
|
|
_start / stop_
|
| ... | @@ -68,7 +66,7 @@ For more details and examples, see the [cii-services user manual](https://www.es |
... | @@ -68,7 +66,7 @@ For more details and examples, see the [cii-services user manual](https://www.es |
|
|
|
|
|
|
|
### How-to get CII Demo apps
|
|
### How-to get CII Demo apps
|
|
|
|
|
|
|
|
CII has demo apps that you can download as source, modify, and build yourself. They demonstrate the use of the CII services.
|
|
CII provices demo apps that you can download as source, modify, and build yourself. They demonstrate the use of the CII services, using plain CII APIs, i.e. without the ECOS applications frameworks (RAD, CUT, etc.).
|
|
|
|
|
|
|
|
```plaintext
|
|
```plaintext
|
|
|
$ git clone https://oauth2:glpat-dFSc881d6hM9A5XMX7Hb@gitlab.eso.org/cii/info/cii-demo.git
|
|
$ git clone https://oauth2:glpat-dFSc881d6hM9A5XMX7Hb@gitlab.eso.org/cii/info/cii-demo.git
|
| ... | @@ -76,18 +74,17 @@ Cloning into 'cii-demo'... |
... | @@ -76,18 +74,17 @@ Cloning into 'cii-demo'... |
|
|
[...]
|
|
[...]
|
|
|
|
|
|
|
|
$ cd cii-demo
|
|
$ cd cii-demo
|
|
|
$ ./cii-demo.sh
|
|
$ waf configure build install
|
|
|
|
|
|
|
|
Building (this may take some minutes) ...
|
|
Building (this may take some minutes) ...
|
|
|
Installing into INTROOT: /home/eltdev/INTROOT
|
|
Installing into INTROOT: /home/eltdev/INTROOT
|
|
|
PREFIX is set to: /home/eltdev/INTROOT
|
|
PREFIX is set to: /home/eltdev/INTROOT
|
|
|
Find the build output in ./cii-demo.sh.build.log
|
|
|
|
|
[...]
|
|
[...]
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
After this, you find the list of available demo apps in the (generated) README file. You can at any time modify the sources and rebuild them with "waf build install". Look inside "cii-demo.sh" if unsure.
|
|
After this, you find the list of available demo apps in the (generated) README file. You can at any time modify the sources and rebuild them with "waf build install".
|
|
|
|
|
|
|
|
Most demo apps require CII Services be running on your host or on another host => Check that the related CII Services (e.g. config service for a a config demo app) are accessible: see [KB: How-to start/stop CII Services](#how-to-start-stop-cii-services)
|
|
Most demo apps require CII Services be running on your host or on another host => Make sure that the related CII Services (e.g. OLDB service for an OLDB demo app) are accessible: see [KB: How-to start/stop CII Services](#how-to-start-stop-cii-services)
|
|
|
|
|
|
|
|
---
|
|
---
|
|
|
|
|
|
| ... | @@ -109,17 +106,20 @@ If you're not even really sure what you're looking for, go and [create a CII tic |
... | @@ -109,17 +106,20 @@ If you're not even really sure what you're looking for, go and [create a CII tic |
|
|
|
|
|
|
|
If you have a fairly clear idea what should be added to the manuals, you can propose and make changes to the documentation source files directly. Contributions are welcome!
|
|
If you have a fairly clear idea what should be added to the manuals, you can propose and make changes to the documentation source files directly. Contributions are welcome!
|
|
|
|
|
|
|
|
The CII all-in-one User Manual is composed of a dozen sub-documents in reStructured text format (.rst). The only (minor) challenge is therefore to identify which sub-document you want to edit.
|
|
The CII User Manuals are written in reStructured text format (.rst).
|
|
|
|
They are located in the following repositories:
|
|
|
|
- [MAL](https://gitlab.eso.org/cii/mal/elt-mal/-/tree/master/doc-project/manuals/src)
|
|
|
|
- [SRV](https://gitlab.eso.org/cii/srv/cii-srv/-/tree/master/doc-project/manuals/src)
|
|
|
|
- [ALARM](https://gitlab.eso.org/cii/srv/cii-ias-bridge/-/blob/master/doc/manual/src)
|
|
|
|
|
|
|
|
The documentation resides in `https://gitlab.eso.org/cii/info/cii-docs.git` that you can clone as usual to local workspace, then modify and create a merge request.
|
|
You can clone these repositories as usual to a local workspace, then modify and create a merge request.
|
|
|
|
|
|
|
|
Alternatively, and recommended, you can edit the files directly in the browser by using the File Editor built into gitlab:
|
|
Alternatively, and simpler, you can edit the files directly in the browser by using the File Editor built into gitlab:
|
|
|
|
|
|
|
|
_Note: If any of the buttons mentioned below is greyed out, you're lacking permissions. If so, please contact us first to request permission._
|
|
_Note: If any of the buttons mentioned below is greyed out, you're lacking permissions. If so, please contact us first to request permission._
|
|
|
|
|
|
|
|
1. Browse to <https://gitlab.eso.org/cii/info/cii-docs>,
|
|
1. Navigate to the repository as listed above
|
|
|
and navigate to folder `userManual/ciiman/src/docs`
|
|
2. Find the .rst file, select it, and press "Edit",
|
|
|
2. Find the correct .rst file, select it, and press "Edit",
|
|
|
|
|
and from the pop-up list of choices, prefer the "Edit single file"
|
|
and from the pop-up list of choices, prefer the "Edit single file"
|
|
|
3. Make your changes in the content editing page.
|
|
3. Make your changes in the content editing page.
|
|
|
Note you can toggle between Write and Preview mode.
|
|
Note you can toggle between Write and Preview mode.
|
| ... | | ... | |