Skip to content

Commit

Permalink
Update Child Config info
Browse files Browse the repository at this point in the history
  • Loading branch information
TheBurchLog authored Jun 21, 2024
1 parent e26df30 commit 09fb8fe
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/app/parent-child.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
= Remote Gardens
:page-layout: docs
:rpm-config-home: /opt/beer-garden/conf

== Parent and Child Gardens

Expand All @@ -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.
Expand Down Expand Up @@ -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 `<garden name>.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?
Expand Down

0 comments on commit 09fb8fe

Please sign in to comment.