marco/plugin-barman-cloud
1
0
Fork 0
mirror of https://github.com/cloudnative-pg/plugin-barman-cloud.git synced 2026-01-12 05:33:11 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: add some missing descriptions

Browse Source 
Signed-off-by: Niccolò Fei <niccolo.fei@enterprisedb.com>
This commit is contained in:
Niccolò Fei 2025-03-24 17:19:14 +01:00 committed by Francesco Canovai
parent 2a86790f4b
commit 8133e81205
2 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api/v1/objectstore_types.go
View File

@ -48,6 +48,7 @@ type ObjectStoreSpec struct {
// +optional
RetentionPolicy string `json:"retentionPolicy,omitempty"`
// The configuration for the sidecar that runs in the instance pods
// +optional
InstanceSidecarConfiguration InstanceSidecarConfiguration `json:"instanceSidecarConfiguration,omitempty"`
}
@ -81,7 +82,12 @@ type ObjectStore struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata"`
// Specification of the desired behavior of the ObjectStore.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Spec ObjectStoreSpec `json:"spec"`
// Most recently observed status of the ObjectStore. This data may not be up to
// date. Populated by the system. Read-only.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional
Status ObjectStoreStatus `json:"status,omitempty"`
}

12
docs/src/plugin-barman-cloud.v1.md
View File

@ -30,13 +30,18 @@
<a href="#barmancloud-cnpg-io-v1-ObjectStoreSpec"><i>ObjectStoreSpec</i></a>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
<p>Specification of the desired behavior of the ObjectStore.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</p>
</td>
</tr>
<tr><td><code>status</code><br/>
<a href="#barmancloud-cnpg-io-v1-ObjectStoreStatus"><i>ObjectStoreStatus</i></a>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
<p>Most recently observed status of the ObjectStore. This data may not be up to
date. Populated by the system. Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status</p>
</td>
</tr>
</tbody>
</table>
@ -108,7 +113,8 @@ days, weeks, months.</p>
<a href="#barmancloud-cnpg-io-v1-InstanceSidecarConfiguration"><i>InstanceSidecarConfiguration</i></a>
</td>
<td>
<span class="text-muted">No description provided.</span></td>
<p>The configuration for the sidecar that runs in the instance pods</p>
</td>
</tr>
</tbody>
</table>