egress: document the allowed ssh connections
This commit is contained in:
parent
8ece0b7e0b
commit
eab2dcb0a2
1 changed files with 73 additions and 19 deletions
|
|
@ -98,12 +98,14 @@ pub struct AgentPermissions {
|
|||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub max_repos: Option<u32>,
|
||||
/// Whether the agent may have its SSH key signed by the swarm's SSH CA. Absent
|
||||
/// is off. Only the controller reads it: it attaches the SSH signing policy
|
||||
/// to the agent's store login role while this is `true`.
|
||||
/// is off. The controller attaches the SSH signing policy to the agent's store
|
||||
/// login role while this is `true`, and a hive lets the agent's
|
||||
/// `ssh_connections` through its forward chain while it is.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub ssh: Option<bool>,
|
||||
/// The named SSH connections the operator declared for the agent. The
|
||||
/// agent renders them into its ssh config while `ssh` is on. Each passes
|
||||
/// agent renders them into its ssh config and its hive allows them on its
|
||||
/// forward chain, while `ssh` is on. Each passes
|
||||
/// [`crate::ssh_connection::SshConnection::checked`] before it is stored,
|
||||
/// and names are unique. A controller built before this field decodes the
|
||||
/// record without it and stores it back without it.
|
||||
|
|
|
|||
Loading…
Reference in a new issue