Skip to content
This repository was archived by the owner on Apr 17, 2025. It is now read-only.

update doc:replace HierarchicalConfiguration with HierarchyConfiguration #70

Merged
merged 1 commit into from
Aug 17, 2021
Merged

update doc:replace HierarchicalConfiguration with HierarchyConfiguration #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/user-guide/concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ to delete it, HNC will simply overwrite the object anyway.

### Tree labels and non-propagated policies

While the hierarchy is _defined_ in the [`HierarchicalConfiguration`](#admin-hc)
While the hierarchy is _defined_ in the [`HierarchyConfiguration`](#admin-hc)
object, it is _reflected_ on the namespaces themselves via HNC-managed labels.

For example, let’s say that namespace `service-1` has a parent `team-a` and a
Expand Down Expand Up @@ -360,7 +360,7 @@ These concepts are useful for anyone who needs to administer hierarchical namesp

Until now, we’ve avoided mentioning how the hierarchy is actually represented in
the cluster. The answer is that every namespace may contain a single object with
the Kind `HierarchicalConfiguration` and the name `hierarchy`. This object is
the Kind `HierarchyConfiguration` and the name `hierarchy`. This object is
used to configure the subtree rooted at the namespace, and also to report any
problems with the hierarchy. It is also the RBAC attachment point (see
“Namespace administrators,” below).
Expand Down Expand Up @@ -439,7 +439,7 @@ Conditions generally require human intervention to resolve, except as described
below.

Namespace conditions are reported as part of the status of the
`HierarchicalConfiguration` object in each namespace and are exposed via the
`HierarchyConfiguration` object in each namespace and are exposed via the
`hnc/namespace_conditions` metric. Cluster conditions are reported as part of
the status of the `HNCConfiguration` cluster-wide object; cluster conditions can
either be caused by problems with the cluster-wide configuration, and are also
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/how-to.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@ kubectl get hncconfiguration config -oyaml > hncconfig.yaml
kubectl get hierarchyconfigurations -A -oyaml > structure.yaml
```

After HNC is reinstalled, it will recreate the `HierarchicalConfiguration`
After HNC is reinstalled, it will recreate the `HierarchyConfiguration`
objects in every namespace, and may automatically create these objects even in
some full namespaces as well (for example, in the parents of subnamespaces). In
order for your backed-up objects to be restored properly, edit `structure.yaml`
Expand Down