From 09fb8febf470cad98d5799a504f77ea3bea83734 Mon Sep 17 00:00:00 2001 From: TheBurchLog <5104941+TheBurchLog@users.noreply.github.com> Date: Fri, 21 Jun 2024 13:24:04 -0400 Subject: [PATCH] Update Child Config info --- docs/app/parent-child.adoc | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/app/parent-child.adoc b/docs/app/parent-child.adoc index 0ac13d1..96d1533 100644 --- a/docs/app/parent-child.adoc +++ b/docs/app/parent-child.adoc @@ -1,5 +1,6 @@ = Remote Gardens :page-layout: docs +:rpm-config-home: /opt/beer-garden/conf == Parent and Child Gardens @@ -14,6 +15,8 @@ execute against, not what systems are connected to itself and children. So if a child tells the Parent it has the ability to route to all of the systems. The Parent will trust the Child Beer Garden to the routing appropriately. +To configure a Child Garden connection information, check out our link:../configuration_yaml/[Configuration Manual] + == Internal Routing The Router requires all objects to utilize the new standard Operation class. @@ -58,14 +61,23 @@ determine the Target Beer Garden, same as the Systems and Instances is looked up === What does a Child emit to the Parent? + Children forward all internal events to their Parents. If there are events that should not be forwarded, then that can be configured in the configuration of Beer Garden. === How does a Parent connect to a Child? -Child configuration is done through the User Interface. If an administrator does not configure the child connection -class, then the Systems connected through that Child are inaccessible. These Systems will appear on the UI, and a user -can create Requests against them, but will be prompted with an error message stating the invalid connection. +If you would like to jump straight to the definitions of Child Configurations, please redirect to +link:../child_config_yaml/[Child Config User Manual] + +Children configuration files are located within the `./children` directory. For RPM installs, the default location is +folder `{rpm-config-home}/children`. + +Child configurations files have a specific naming convention for the file. The file should be named as `.yaml`. +The filename prior to `.yaml` will be stored as the Garden Name in the database. At file reload, all values will be overwritten. + +If an administrator does not configure the child, then the Systems connected through that Child are inaccessible. These Systems will not +be routable for Requests and not appear on the Systems page. === How does a Child connect to a Parent?