ophix-conf-client

Python client for ophix-confs configuration servers.

Provides a CLI for operators and an importable library for automation scripts and Tier 2 clients. Fetches named configuration snippets (YAML, JSON, XML, INI, TOML, .env, raw) verbatim from the server.

Installation

pip install ophix-conf-client venv-cmds

venv-cmds is optional but recommended — it provides venv-cmds list to discover all commands available in the venv and venv-cmds check_updates to check for new releases.

Quick start

# Bootstrap in one step
conf-client quickstart https://confserver.internal my-client

# Fetch a configuration (raw content printed to stdout)
conf-client fetch nginx_upstream

# Fetch with format info header
conf-client fetch nginx_upstream --format-info

# Import a configuration file
conf-client import --input-file nginx.conf --name nginx_upstream --format raw

# Import with format inferred from extension
conf-client import --input-file app_config.yaml --name app_config

# Check all configurations mapped in .conf.env
conf-client check --all

# Diagnose config and connectivity
conf-client doctor

Configuration

Settings are stored in .conf.env (mode 600).

Additional keys in .conf.env are treated as configuration name mappings used by check --all — each key maps an environment variable name to a configuration name on the server.

CLI reference

conf-client quickstart <server_url> <client_name> [--deployment-ref ...]
conf-client fetch {--name <n>|--var <VAR>} [--output-file <path>] [--format-info]
conf-client register <name> [deployment_ref]
conf-client update [--deployment-ref ...]
conf-client set {server|ca-cert|token} <value>
conf-client download ca-cert
conf-client import --input-file <file> [--name <n>] [--var <VAR>] [--format <fmt>] [--overwrite]
conf-client check {--all|--var <VAR>|--name <name>} [--verbose]
conf-client info
conf-client rotate-token
conf-client doctor

fetch

--output-file <path> writes the content directly to a file instead of stdout. Parent directories are created automatically. Use - as the path for explicit stdout. When writing to a file, --format-info prints format and timestamp to stdout separately rather than embedding them in the file.

import

Add --overwrite to update an existing configuration.

Python API — Tier 2 clients

from conf_client.core import get_config

# Reads config name from the named env var, fetches from server,
# returns raw content string. Calls sys.exit(1) on failure.
nginx_conf = get_config("NGINX_CONFIG_NAME")

# Write directly to file
with open("/etc/nginx/conf.d/upstream.conf", "w") as f:
    f.write(nginx_conf)

Full CRUD:

from conf_client.core import (
    fetch_config,    # returns (content, format_name, updated_at)
    create_config,
    update_config,
    delete_config,
)

fetch_config returns a (content, format_name, updated_at) tuple rather than a dict, since the content is raw text. The format name and timestamp come from response headers. get_config returns the raw content string directly.

Server

This client connects to ophix-confs.