Use consistent naming of components
Rename "pvcd" to "pvcnoded", and "pvc-api" to "pvcapid" so names for the daemons are fully consistent. Update the names of the configuration files as well to match this new formatting. References #79
This commit is contained in:
@ -50,7 +50,7 @@ The API client uses a dedicated, independent set of functions to perform the act
|
||||
|
||||
### CLI client
|
||||
|
||||
The CLI client interface is a Click application, which provides a convenient CLI interface to the API client. It supports connecting to multiple clusters, over both HTTP and HTTPS and with authentication, including a special "local" cluster if the client determines that an `/etc/pvc/pvc-api.yaml` configuration exists on the host.
|
||||
The CLI client interface is a Click application, which provides a convenient CLI interface to the API client. It supports connecting to multiple clusters, over both HTTP and HTTPS and with authentication, including a special "local" cluster if the client determines that an `/etc/pvc/pvcapid.yaml` configuration exists on the host.
|
||||
|
||||
The CLI client is self-documenting using the `-h`/`--help` arguments, though a short manual can be found at the [CLI manual page](/manuals/cli).
|
||||
|
||||
|
@ -14,15 +14,15 @@ During startup, the system scans the Zookeeper database and sets up the required
|
||||
|
||||
## Startup sequence
|
||||
|
||||
The daemon startup sequence is documented below. The main daemon entry-point is `Daemon.py` inside the `pvcd` folder, which is called from the `pvcd.py` stub file.
|
||||
The daemon startup sequence is documented below. The main daemon entry-point is `Daemon.py` inside the `pvcnoded` folder, which is called from the `pvcnoded.py` stub file.
|
||||
|
||||
0. The configuration is read from `/etc/pvc/pvcd.yaml` and the configuration object set up.
|
||||
0. The configuration is read from `/etc/pvc/pvcnoded.yaml` and the configuration object set up.
|
||||
|
||||
0. Any required filesystem directories, mostly dynamic directories, are created.
|
||||
|
||||
0. The logger is set up. If file logging is enabled, this is the state when the first log messages are written.
|
||||
|
||||
0. Host networking is configured based on the `pvcd.yaml` configuration file. In a normal cluster, this is the point where the node will become reachable on the network as all networking is handled by the PVC node daemon.
|
||||
0. Host networking is configured based on the `pvcnoded.yaml` configuration file. In a normal cluster, this is the point where the node will become reachable on the network as all networking is handled by the PVC node daemon.
|
||||
|
||||
0. Sysctl tweaks are applied to the host system, to enable routing/forwarding between nodes via the host.
|
||||
|
||||
|
@ -8,7 +8,7 @@ The [`pvc-ansible`](https://github.com/parallelvirtualcluster/pvc-ansible) frame
|
||||
|
||||
### SSL
|
||||
|
||||
The API accepts SSL certificate and key files via the `pvc-api.yaml` configuration to enable SSL support for the API, which protects the data and query values from snooping or tampering. SSL is strongly recommended if using the API outside of a trusted local area network.
|
||||
The API accepts SSL certificate and key files via the `pvcapid.yaml` configuration to enable SSL support for the API, which protects the data and query values from snooping or tampering. SSL is strongly recommended if using the API outside of a trusted local area network.
|
||||
|
||||
### API authentication
|
||||
|
||||
@ -148,7 +148,7 @@ curl -X GET http://localhost:7370/api/v1/provisioner/status/<task-id>
|
||||
|
||||
## API Daemon Configuration
|
||||
|
||||
The API is configured using a YAML configuration file which is passed in to the API process by the environment variable `PVC_CONFIG_FILE`. When running with the default package and SystemD unit, this file is located at `/etc/pvc/pvc-api.yaml`.
|
||||
The API is configured using a YAML configuration file which is passed in to the API process by the environment variable `PVC_CONFIG_FILE`. When running with the default package and SystemD unit, this file is located at `/etc/pvc/pvcapid.yaml`.
|
||||
|
||||
### Conventions
|
||||
|
||||
@ -156,7 +156,7 @@ The API is configured using a YAML configuration file which is passed in to the
|
||||
|
||||
* Settings may `depends` on other settings. This indicates that, if one setting is enabled, the other setting is very likely `required` by that setting.
|
||||
|
||||
### `pvc-api.yaml`
|
||||
### `pvcapid.yaml`
|
||||
|
||||
Example configuration:
|
||||
|
||||
|
@ -4,7 +4,7 @@ The PVC CLI client is built with Click, a Python framework for creating self-doc
|
||||
|
||||
Use the `-h` option at any level of the `pvc` CLI command to receive help about the available commands and options.
|
||||
|
||||
Before using the CLI on a non-PVC node system, at least one cluster must be added using the `pvc cluster` subcommands. Running the CLI on hosts which also run the PVC API (via its configuration at `/etc/pvc/pvc-api.yaml`) uses the special `local` cluster, reading information from the API configuration, by default.
|
||||
Before using the CLI on a non-PVC node system, at least one cluster must be added using the `pvc cluster` subcommands. Running the CLI on hosts which also run the PVC API (via its configuration at `/etc/pvc/pvcapid.yaml`) uses the special `local` cluster, reading information from the API configuration, by default.
|
||||
|
||||
## Configuration
|
||||
|
||||
|
@ -4,7 +4,7 @@ The PVC node daemon ins build with Python 3 and is run directly on nodes. For de
|
||||
|
||||
## Configuration
|
||||
|
||||
The Daemon is configured using a YAML configuration file which is passed in to the API process by the environment variable `PVCD_CONFIG_FILE`. When running with the default package and SystemD unit, this file is located at `/etc/pvc/pvcd.yaml`.
|
||||
The Daemon is configured using a YAML configuration file which is passed in to the API process by the environment variable `PVCD_CONFIG_FILE`. When running with the default package and SystemD unit, this file is located at `/etc/pvc/pvcnoded.yaml`.
|
||||
|
||||
For most deployments, the management of the configuration file is handled entirely by the [PVC Ansible framework](/manuals/ansible) and should not be modified directly. Many options from the Ansible framework map directly into the configuration options in this file.
|
||||
|
||||
@ -14,7 +14,7 @@ For most deployments, the management of the configuration file is handled entire
|
||||
|
||||
* Settings may `depends` on other settings. This indicates that, if one setting is enabled, the other setting is very likely `required` by that setting.
|
||||
|
||||
### `pvcd.yaml`
|
||||
### `pvcnoded.yaml`
|
||||
|
||||
Example configuration:
|
||||
|
||||
|
Reference in New Issue
Block a user