OCS
User Guide
Introduction
Dependencies
Installation
Quickstart
System Configuration
Network Configuration
Log Aggregation
ocs-web
CLI Tools
Agent Reference
Access Director Agent
Aggregator Agent
Barebones Agent
InfluxDB Publisher Agent
InfluxDB Publisher v2 Agent
Registry Agent
Fake Data Agent
HostManager Agent
Developer Guide
Architecture of the OCS
OCS Site Configuration
Agents
Clients and Control Programs
Data Access
Writing Plugins
Access Control
Docker
Testing
API Reference
API
OCS
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
_access_handler() (ocs.ocs_agent.OCSAgent method)
_count (ocs.agents.barebones.agent.BarebonesAgent attribute)
_gather_sessions() (ocs.ocs_agent.OCSAgent method)
_get_op() (in module ocs.ocs_client)
_handle_task_error() (ocs.ocs_agent.OCSAgent method)
_handle_task_return_val() (ocs.ocs_agent.OCSAgent method)
_management_handler() (ocs.ocs_agent.OCSAgent method)
_ops_handler() (ocs.ocs_agent.OCSAgent method)
_reload_config() (ocs.agents.host_manager.agent.HostManager method)
_shutdown() (ocs.ocs_agent.OCSAgent method)
_stop_all_running_sessions() (ocs.ocs_agent.OCSAgent method)
_stop_helper() (ocs.ocs_agent.OCSAgent method)
_store_subscription() (ocs.ocs_agent.OCSAgent method)
_unsub_error() (ocs.ocs_agent.OCSAgent method)
_unsubscribe_all() (ocs.ocs_agent.OCSAgent method)
A
abort() (ocs.client_t.TaskClient method)
(ocs.ocs_agent.OCSAgent method)
AC_VERSION (in module ocs.access)
AccessDirector (class in ocs.agents.access_director.agent)
AccessDirectorConfig (class in ocs.access)
AccessPasswordItem (class in ocs.access)
AccessRule (class in ocs.access)
acq() (ocs.agents.fake_data.agent.FakeDataAgent method)
acquire() (ocs.access.ExclusiveAccessClient method)
(ocs.ocs_twisted.TimeoutLock method)
acquire_timeout() (ocs.ocs_twisted.TimeoutLock method)
action (ocs.access.ActionContext attribute)
ActionContext (class in ocs.access)
add_arguments() (in module ocs.site_config)
add_message() (ocs.ocs_agent.OpSession method)
add_provider() (ocs.agents.aggregator.drivers.Aggregator method)
add_site_attributes() (in module ocs.site_config)
ADVANCED (ocs.access.CredLevel attribute)
agent (ocs.access.AgentAccessRules attribute)
(ocs.agents.barebones.agent.BarebonesAgent attribute)
agent_class (ocs.access.AccessPasswordItem attribute)
(ocs.access.AgentSpec attribute)
(ocs.access.GrantConfigItem attribute)
(ocs.access.ScopeSpec attribute)
agent_filter_rules() (in module ocs.access)
agent_get_creds() (in module ocs.access)
agent_get_policy_default() (in module ocs.access)
agent_poll() (ocs.agents.access_director.agent.AccessDirector method)
agent_rejection_message() (in module ocs.access)
agent_timeout (ocs.agents.registry.agent.Registry attribute)
AgentAccessRules (class in ocs.access)
AgentOp (class in ocs.ocs_agent)
AgentProcess (class in ocs.ocs_agent)
AgentProcessHelper (class in ocs.agents.host_manager.drivers)
AgentSpec (class in ocs.access)
AgentTask (class in ocs.ocs_agent)
aggregate (ocs.agents.aggregator.agent.AggregatorAgent attribute)
(ocs.agents.influxdb_publisher.agent.InfluxDBAgent attribute)
(ocs.agents.influxdb_publisher_v2.agent.InfluxDBAgentv2 attribute)
Aggregator (class in ocs.agents.aggregator.drivers)
AggregatorAgent (class in ocs.agents.aggregator.agent)
append() (ocs.ocs_feed.Block method)
arg_dict (ocs.site_config.ArgContainer attribute)
ArgContainer (class in ocs.site_config)
B
BarebonesAgent (class in ocs.agents.barebones.agent)
BASIC (ocs.access.CredLevel attribute)
batch() (ocs.ocs_agent.ParamHandler method)
Block (class in ocs.ocs_feed)
BLOCKED (ocs.access.CredLevel attribute)
blocks (ocs.agents.aggregator.drivers.Provider attribute)
build_agent_list() (in module ocs.agent_cli)
C
call() (ocs.client_http.ControlClient method)
call_op() (ocs.ocs_agent.OCSAgent method)
check() (ocs.access.HashedPass method)
(ocs.access.ScopeSpec method)
check_crossbar_connection() (in module ocs.testing)
check_for_strays() (ocs.ocs_agent.ParamHandler method)
clear() (ocs.agents.aggregator.drivers.Provider method)
(ocs.ocs_feed.Block method)
client (ocs.agents.influxdb_publisher.agent.Publisher attribute)
(ocs.agents.influxdb_publisher.drivers.Publisher attribute)
(ocs.agents.influxdb_publisher_v2.agent.Publisher attribute)
client_args (ocs.agents.influxdb_publisher.agent.Publisher attribute)
(ocs.agents.influxdb_publisher.drivers.Publisher attribute)
client_get_password() (in module ocs.access)
close() (ocs.agents.aggregator.drivers.Aggregator method)
(ocs.agents.influxdb_publisher.agent.Publisher method)
(ocs.agents.influxdb_publisher.drivers.Publisher method)
(ocs.agents.influxdb_publisher_v2.agent.Publisher method)
close_file() (ocs.agents.aggregator.drivers.G3FileRotator method)
connectionMade() (ocs.agents.host_manager.drivers.AgentProcessHelper method)
ControlClient (class in ocs.client_http)
ControlClientError
ControlClientSession (class in ocs.client_t)
count() (ocs.agents.barebones.agent.BarebonesAgent method)
create_agent_runner_fixture() (in module ocs.testing)
create_blocked() (ocs.access.HashedPass class method)
create_client_fixture() (in module ocs.testing)
create_free() (ocs.access.HashedPass class method)
create_from_value() (ocs.access.HashedPass class method)
CRED_KEYS (in module ocs.access)
cred_level (ocs.access.AccessRule attribute)
(ocs.access.GrantConfigItem attribute)
CredLevel (class in ocs.access)
CrossbarConfig (class in ocs.site_config)
current_file (ocs.agents.aggregator.drivers.G3FileRotator attribute)
D
data_dir (ocs.agents.aggregator.agent.AggregatorAgent attribute)
(ocs.agents.influxdb_publisher.agent.InfluxDBAgent attribute)
(ocs.agents.influxdb_publisher_v2.agent.InfluxDBAgentv2 attribute)
db (ocs.agents.influxdb_publisher.agent.Publisher attribute)
(ocs.agents.influxdb_publisher.drivers.Publisher attribute)
(ocs.agents.influxdb_publisher_v2.agent.Publisher attribute)
default (ocs.access.AccessPasswordItem attribute)
(ocs.access.GrantConfigItem attribute)
(ocs.access.ScopeSpec attribute)
DEGRADED (ocs.base.OpCode attribute)
delay_task() (ocs.agents.fake_data.agent.FakeDataAgent method)
director_get_access_rules() (in module ocs.access)
director_id (ocs.access.AgentAccessRules attribute)
director_parse_config() (in module ocs.access)
distrib_hashfunc (ocs.access.AccessDirectorConfig attribute)
DistributedAccessGrant (class in ocs.access)
DockerContainerHelper (class in ocs.agents.host_manager.drivers)
dsleep() (ocs.ocs_twisted.Pacemaker method)
E
empty() (ocs.agents.aggregator.drivers.Provider method)
(ocs.ocs_feed.Block method)
encoded() (ocs.agents.aggregator.drivers.Provider method)
(ocs.ocs_agent.AgentProcess method)
(ocs.ocs_agent.AgentTask method)
(ocs.ocs_agent.OCSAgent method)
(ocs.ocs_agent.OpSession method)
(ocs.ocs_feed.Block method)
(ocs.ocs_feed.Feed method)
enforce_field_name_rules() (ocs.ocs_feed.Feed static method)
ERROR (ocs.base.ResponseCode attribute)
errReceived() (ocs.agents.host_manager.drivers.AgentProcessHelper method)
exclusive_access_blocks (ocs.access.AccessDirectorConfig attribute)
ExclusiveAccessClient (class in ocs.access)
expired (ocs.agents.registry.agent.RegisteredAgent attribute)
EXPIRED (ocs.base.OpCode attribute)
extend() (ocs.ocs_feed.Block method)
F
FAILED (ocs.base.OpCode attribute)
FakeDataAgent (class in ocs.agents.fake_data.agent)
Feed (class in ocs.ocs_feed)
file_start_time (ocs.agents.aggregator.drivers.G3FileRotator attribute)
filename (ocs.agents.aggregator.drivers.G3FileRotator attribute)
flush() (ocs.agents.aggregator.drivers.G3FileRotator method)
flush_buffer() (ocs.ocs_feed.Feed method)
frame_start_time (ocs.agents.aggregator.drivers.Provider attribute)
fresh_time (ocs.agents.aggregator.drivers.Provider attribute)
from_dict() (ocs.site_config.CrossbarConfig class method)
(ocs.site_config.HostConfig class method)
(ocs.site_config.HubConfig class method)
(ocs.site_config.InstanceConfig class method)
(ocs.site_config.SiteConfig class method)
from_yaml() (ocs.site_config.SiteConfig class method)
FULL (ocs.access.CredLevel attribute)
G
g3_cast() (in module ocs.agents.aggregator.drivers)
G3FileRotator (class in ocs.agents.aggregator.drivers)
generate_id() (in module ocs.agents.aggregator.drivers)
get() (ocs.ocs_agent.ParamHandler method)
get_api() (ocs.client_http.ControlClient method)
get_cmd() (ocs.site_config.CrossbarConfig method)
get_config() (in module ocs.site_config)
get_control_client() (in module ocs.site_config)
get_feeds() (ocs.client_http.ControlClient method)
get_processes() (ocs.client_http.ControlClient method)
get_scope_spec() (ocs.access.AccessPasswordItem method)
(ocs.access.GrantConfigItem method)
get_specificity() (ocs.access.ScopeSpec method)
get_tasks() (ocs.client_http.ControlClient method)
GrantConfigItem (class in ocs.access)
grants (ocs.access.DistributedAccessGrant attribute)
H
hash (ocs.access.DistributedAccessGrant attribute)
(ocs.access.HashedPass attribute)
hashed_pass (ocs.access.AccessRule attribute)
HashedPass (class in ocs.access)
hksess (ocs.agents.aggregator.drivers.Aggregator attribute)
HostConfig (class in ocs.site_config)
HostManager (class in ocs.agents.host_manager.agent)
HubConfig (class in ocs.site_config)
I
in_reactor_context() (in module ocs.ocs_twisted)
incoming_data (ocs.agents.aggregator.agent.AggregatorAgent attribute)
(ocs.agents.influxdb_publisher.agent.InfluxDBAgent attribute)
(ocs.agents.influxdb_publisher.agent.Publisher attribute)
(ocs.agents.influxdb_publisher.drivers.Publisher attribute)
(ocs.agents.influxdb_publisher_v2.agent.InfluxDBAgentv2 attribute)
(ocs.agents.influxdb_publisher_v2.agent.Publisher attribute)
inConnectionLost() (ocs.agents.host_manager.drivers.AgentProcessHelper method)
InfluxDBAgent (class in ocs.agents.influxdb_publisher.agent)
InfluxDBAgentv2 (class in ocs.agents.influxdb_publisher_v2.agent)
init_site_agent() (in module ocs.ocs_agent)
instance_id (ocs.access.AccessPasswordItem attribute)
(ocs.access.AgentSpec attribute)
(ocs.access.GrantConfigItem attribute)
(ocs.access.ScopeSpec attribute)
(ocs.ocs_client.OCSClient attribute)
InstanceConfig (class in ocs.site_config)
L
last_block_received (ocs.agents.aggregator.drivers.Provider attribute)
last_refresh (ocs.agents.aggregator.drivers.Provider attribute)
last_session (ocs.agents.aggregator.drivers.G3FileRotator attribute)
last_status (ocs.agents.aggregator.drivers.G3FileRotator attribute)
last_updated (ocs.agents.registry.agent.RegisteredAgent attribute)
launch_deferred() (ocs.ocs_agent.AgentOp method)
lock (ocs.agents.barebones.agent.BarebonesAgent attribute)
lockout_id (ocs.access.AccessRule attribute)
lockout_levels (ocs.access.AccessRule attribute)
(ocs.access.GrantConfigItem attribute)
lockout_owner (ocs.access.AccessRule attribute)
log (ocs.agents.aggregator.drivers.Aggregator attribute)
(ocs.agents.aggregator.drivers.Provider attribute)
(ocs.agents.barebones.agent.BarebonesAgent attribute)
log_formatter() (in module ocs.ocs_agent)
loop_time (ocs.agents.aggregator.agent.AggregatorAgent attribute)
(ocs.agents.influxdb_publisher.agent.InfluxDBAgent attribute)
(ocs.agents.influxdb_publisher_v2.agent.InfluxDBAgentv2 attribute)
M
main() (ocs.agents.registry.agent.Registry method)
make_filename() (in module ocs.agents.aggregator.drivers)
ManagedInstance (class in ocs.agents.host_manager.drivers)
manager() (ocs.agents.access_director.agent.AccessDirector method)
(ocs.agents.host_manager.agent.HostManager method)
module
ocs.access
ocs.agent_cli
ocs.agents.aggregator.drivers
ocs.agents.host_manager.drivers
ocs.agents.influxdb_publisher.drivers
ocs.base
ocs.client_http
ocs.client_t
ocs.ocs_agent
ocs.ocs_client
ocs.ocs_feed
ocs.ocs_twisted
ocs.site_config
ocs.testing
N
name (ocs.access.DistributedAccessGrant attribute)
new_frame_time() (ocs.agents.aggregator.drivers.Provider method)
NONE (ocs.base.OpCode attribute)
O
ocs.access
module
ocs.agent_cli
module
ocs.agents.aggregator.drivers
module
ocs.agents.host_manager.drivers
module
ocs.agents.influxdb_publisher.drivers
module
ocs.base
module
ocs.client_http
module
ocs.client_t
module
ocs.ocs_agent
module
ocs.ocs_client
module
ocs.ocs_feed
module
ocs.ocs_twisted
module
ocs.site_config
module
ocs.testing
module
OCSAgent (class in ocs.ocs_agent)
OCSClient (class in ocs.ocs_client)
OCSReply (class in ocs.ocs_client)
OK (ocs.base.ResponseCode attribute)
onChallenge() (ocs.client_t.ControlClientSession method)
(ocs.ocs_agent.OCSAgent method)
onConnect() (ocs.client_t.ControlClientSession method)
(ocs.ocs_agent.OCSAgent method)
onDisconnect() (ocs.client_t.ControlClientSession method)
(ocs.ocs_agent.OCSAgent method)
onJoin() (ocs.client_t.ControlClientSession method)
(ocs.ocs_agent.OCSAgent method)
onLeave() (ocs.client_t.ControlClientSession method)
(ocs.ocs_agent.OCSAgent method)
op_code (ocs.ocs_agent.OpSession property)
op_codes (ocs.agents.registry.agent.RegisteredAgent attribute)
op_name (ocs.access.ActionContext attribute)
OpCode (class in ocs.base)
OperationClient (class in ocs.client_t)
OpSession (class in ocs.ocs_agent)
outReceived() (ocs.agents.host_manager.drivers.AgentProcessHelper method)
P
Pacemaker (class in ocs.ocs_twisted)
param() (in module ocs.ocs_agent)
ParamError
ParamHandler (class in ocs.ocs_agent)
parse_args() (in module ocs.site_config)
parse_docker_state() (in module ocs.agents.host_manager.drivers)
password (ocs.access.DistributedAccessGrant attribute)
password_1 (ocs.access.AccessPasswordItem attribute)
password_2 (ocs.access.AccessPasswordItem attribute)
password_3 (ocs.access.AccessPasswordItem attribute)
password_4 (ocs.access.AccessPasswordItem attribute)
passwords (ocs.access.AccessDirectorConfig attribute)
passwords_block_default_hashfunc (ocs.access.AccessDirectorConfig attribute)
pattern_match() (in module ocs.access)
pids (ocs.agents.aggregator.drivers.Aggregator attribute)
policy (ocs.access.AgentAccessRules attribute)
print() (ocs.agents.barebones.agent.BarebonesAgent method)
Process() (ocs.agents.aggregator.drivers.G3FileRotator method)
process_incoming_data() (ocs.agents.aggregator.drivers.Aggregator method)
(ocs.agents.influxdb_publisher.agent.Publisher method)
(ocs.agents.influxdb_publisher.drivers.Publisher method)
(ocs.agents.influxdb_publisher_v2.agent.Publisher method)
ProcessClient (class in ocs.client_t)
processExited() (ocs.agents.host_manager.drivers.AgentProcessHelper method)
protocol (ocs.agents.influxdb_publisher.agent.Publisher attribute)
(ocs.agents.influxdb_publisher.drivers.Publisher attribute)
Provider (class in ocs.agents.aggregator.drivers)
providers (ocs.agents.aggregator.drivers.Aggregator attribute)
publish_message() (ocs.ocs_feed.Feed method)
publish_to_feed() (ocs.ocs_agent.OCSAgent method)
Publisher (class in ocs.agents.influxdb_publisher.agent)
(class in ocs.agents.influxdb_publisher.drivers)
(class in ocs.agents.influxdb_publisher_v2.agent)
purge_log() (ocs.ocs_agent.OpSession method)
R
record() (ocs.agents.aggregator.agent.AggregatorAgent method)
(ocs.agents.influxdb_publisher.agent.InfluxDBAgent method)
(ocs.agents.influxdb_publisher_v2.agent.InfluxDBAgentv2 method)
refresh() (ocs.agents.aggregator.drivers.Provider method)
register_feed() (ocs.ocs_agent.OCSAgent method)
register_process() (ocs.ocs_agent.OCSAgent method)
register_task() (ocs.ocs_agent.OCSAgent method)
registered_agents (ocs.agents.registry.agent.Registry attribute)
RegisteredAgent (class in ocs.agents.registry.agent)
Registry (class in ocs.agents.registry.agent)
release() (ocs.access.ExclusiveAccessClient method)
(ocs.ocs_twisted.TimeoutLock method)
release_and_acquire() (ocs.ocs_twisted.TimeoutLock method)
reload_config() (ocs.agents.access_director.agent.AccessDirector method)
remove_provider() (ocs.agents.aggregator.drivers.Aggregator method)
remove_stale_providers() (ocs.agents.aggregator.drivers.Aggregator method)
renew() (ocs.access.ExclusiveAccessClient method)
request() (ocs.client_http.ControlClient method)
(ocs.client_t.OperationClient method)
request_exclusive() (ocs.agents.access_director.agent.AccessDirector method)
resolve_child_state() (in module ocs.agents.host_manager.drivers)
ResponseCode (class in ocs.base)
rules (ocs.access.AgentAccessRules attribute)
run() (ocs.agents.aggregator.drivers.Aggregator method)
(ocs.agents.influxdb_publisher.agent.Publisher method)
(ocs.agents.influxdb_publisher.drivers.Publisher method)
(ocs.agents.influxdb_publisher_v2.agent.Publisher method)
run_control_script() (in module ocs.client_t)
RUNNING (ocs.base.OpCode attribute)
S
save_to_block() (ocs.agents.aggregator.drivers.Provider method)
scope_spec (ocs.access.AccessRule attribute)
ScopeSpec (class in ocs.access)
SESSION_STATUS_CODES (in module ocs.ocs_agent)
set_heartbeat() (ocs.agents.fake_data.agent.FakeDataAgent method)
set_status() (ocs.ocs_agent.OpSession method)
SiteConfig (class in ocs.site_config)
sleep() (ocs.ocs_twisted.Pacemaker method)
special() (ocs.client_http.ControlClient method)
stability_factor() (in module ocs.agents.host_manager.drivers)
stale() (ocs.agents.aggregator.drivers.Provider method)
start() (ocs.client_http.ControlClient method)
(ocs.client_t.OperationClient method)
(ocs.ocs_agent.OCSAgent method)
STARTING (ocs.base.OpCode attribute)
status() (ocs.client_t.OperationClient method)
(ocs.ocs_agent.OCSAgent method)
stop() (ocs.client_http.ControlClient method)
(ocs.client_t.ProcessClient method)
(ocs.ocs_agent.OCSAgent method)
STOPPING (ocs.base.OpCode attribute)
subscribe() (ocs.ocs_agent.OCSAgent method)
subscribe_on_start() (ocs.ocs_agent.OCSAgent method)
subscribe_to_feed() (ocs.ocs_agent.OCSAgent method)
SUCCEEDED (ocs.base.OpCode attribute)
summarize_dict() (in module ocs.site_config)
summary() (ocs.site_config.CrossbarConfig method)
(ocs.site_config.HubConfig method)
SUPERUSER (ocs.access.CredLevel attribute)
superuser_key (ocs.access.AgentSpec attribute)
T
TaskClient (class in ocs.client_t)
time_expired (ocs.agents.registry.agent.RegisteredAgent attribute)
time_per_file (ocs.agents.aggregator.agent.AggregatorAgent attribute)
TIMEOUT (ocs.base.ResponseCode attribute)
TimeoutLock (class in ocs.ocs_twisted)
to_frame() (ocs.agents.aggregator.drivers.Provider method)
to_list() (ocs.site_config.ArgContainer method)
U
update() (ocs.agents.host_manager.agent.HostManager method)
(ocs.agents.host_manager.drivers.DockerContainerHelper method)
(ocs.site_config.ArgContainer method)
V
value (ocs.access.HashedPass attribute)
verify_data_field_string() (ocs.ocs_feed.Feed static method)
verify_message_data_type() (ocs.ocs_feed.Feed static method)
W
wait() (ocs.client_t.OperationClient method)
(ocs.ocs_agent.OCSAgent method)
write_status (ocs.agents.aggregator.drivers.Aggregator attribute)
write_to_disk() (ocs.agents.aggregator.drivers.Aggregator method)
writer (ocs.agents.aggregator.drivers.Aggregator attribute)
(ocs.agents.aggregator.drivers.G3FileRotator attribute)