From 154caf8aa7ee1f1a84c9157cd89daf47f483d833 Mon Sep 17 00:00:00 2001 From: tunahanertekin Date: Mon, 16 Oct 2023 13:14:20 +0300 Subject: [PATCH] docs(reference): update reference docs --- docs/reference/README.md | 37 +++++++++++++++++-------------------- 1 file changed, 17 insertions(+), 20 deletions(-) diff --git a/docs/reference/README.md b/docs/reference/README.md index 73b27aef..4a01cc31 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -76,7 +76,7 @@ _Appears in:_ | `image` _string_ | Main image of Robot. It is derived either from the specifications or determined directly over labels. | | `uid` _integer_ | User ID of robolaunch user in image. | | `nodeName` _string_ | Node that Robot uses. It is selected via tenancy labels. | -| `volumeStatuses` _[VolumeStatuses](#volumestatuses)_ | Robot persists some of the directories of underlying OS inside persistent volumes. This field exposes persistent volume claims that dynamically provision PVs. | +| `persistentDirs` _[PersistentDirectory](#persistentdirectory) array_ | [*alpha*] Status of PVCs of persistent directories. | | `discoveryServerStatus` _[DiscoveryServerInstanceStatus](#discoveryserverinstancestatus)_ | Discovery server instance status. | | `rosBridgeStatus` _[ROSBridgeInstanceStatus](#rosbridgeinstancestatus)_ | ROS bridge instance status. | | `loaderJobStatus` _[OwnedResourceStatus](#ownedresourcestatus)_ | Status of loader job that configures environment. | @@ -1049,6 +1049,7 @@ _Appears in:_ - [OwnedPodStatus](#ownedpodstatus) - [OwnedRobotServiceStatus](#ownedrobotservicestatus) - [OwnedServiceStatus](#ownedservicestatus) +- [PersistentDirectory](#persistentdirectory) - [ROSBridgeInstanceStatus](#rosbridgeinstancestatus) - [ROSBridgeStatus](#rosbridgestatus) - [RelayServerStatus](#relayserverstatus) @@ -1057,7 +1058,6 @@ _Appears in:_ - [RobotStatus](#robotstatus) - [RobotVDIStatus](#robotvdistatus) - [StepStatus](#stepstatus) -- [VolumeStatuses](#volumestatuses) - [WorkspaceManagerInstanceStatus](#workspacemanagerinstancestatus) - [WorkspaceManagerStatus](#workspacemanagerstatus) @@ -1101,6 +1101,21 @@ _Appears in:_ | `url` _string_ | Connection URL. | +#### PersistentDirectory + + + + + +_Appears in:_ +- [RobotStatus](#robotstatus) + +| Field | Description | +| --- | --- | +| `path` _string_ | | +| `status` _[OwnedResourceStatus](#ownedresourcestatus)_ | | + + #### RMWImplementation _Underlying type:_ `string` @@ -1367,24 +1382,6 @@ _Appears in:_ | `network` _[NetworkLoadStatus](#networkloadstatus)_ | Network usage information. | -#### VolumeStatuses - - - - - -_Appears in:_ -- [RobotStatus](#robotstatus) - -| Field | Description | -| --- | --- | -| `varDir` _[OwnedResourceStatus](#ownedresourcestatus)_ | Holds PVC status of the `/var` directory of underlying OS. | -| `etcDir` _[OwnedResourceStatus](#ownedresourcestatus)_ | Holds PVC status of the `/etc` directory of underlying OS. | -| `usrDir` _[OwnedResourceStatus](#ownedresourcestatus)_ | Holds PVC status of the `/usr` directory of underlying OS. | -| `optDir` _[OwnedResourceStatus](#ownedresourcestatus)_ | Holds PVC status of the `/opt` directory of underlying OS. | -| `workspaceDir` _[OwnedResourceStatus](#ownedresourcestatus)_ | Holds PVC status of the workspaces directory of underlying OS. | - - #### Workspace