Skip to content

Commit

Permalink
update connection types labels and annotations docs
Browse files Browse the repository at this point in the history
  • Loading branch information
christianvogt committed Sep 23, 2024
1 parent 306269d commit 25cffe3
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
6 changes: 3 additions & 3 deletions documentation/components/dashboard/dashboardStorage.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ Flows that can be performed by any user, provided the [feature is enabled](./con

These are all stored as K8s resources using OCP or OpenShift AI backing CRDs.

#### Data Connections
#### Connections

Data connections is a concept created by the Dashboard to store information relative to the user's Data Connection. This information is stored in a K8s secret of a specific structure:
Connections is a concept created by the Dashboard to store information relative to the user's Data Connection. This information is stored in a K8s secret of a specific structure:

```yaml
kind: Secret
Expand All @@ -76,4 +76,4 @@ data:
type: Opaque
```
See more information on the labels & annotations in the [Data Connection section of the K8s Labels & Annotations](./k8sLabelsAndAnnotations.md#data-connections)
See more information on the labels & annotations in the [Connection section of the K8s Labels & Annotations](./k8sLabelsAndAnnotations.md#connections)
19 changes: 14 additions & 5 deletions documentation/components/dashboard/k8sLabelsAndAnnotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Dashboard has a reputation of using a lot of annotations and labels on various r
* [`opendatahub.io/sc-config`]
* [Specific Use-Cases](#specific-use-cases)
* [DS Projects](#data-science-projects)
* [Data Connections](#data-connections)
* [Connections](#connections)
* [ImageStreams](#imagestreams)
* [Notebooks](#notebooks)
* [ServingRuntime Templates](#servingruntime-templates)
Expand Down Expand Up @@ -111,15 +111,24 @@ This annotation is used as internal Dashboard metadata to describe, enable, and
For the Project Sharing feature specifically:
* Label `opendatahub.io/project-sharing` is used to denote permissions crafted by Dashboard flows & thus show up in the Dashboard UI

### Data Connections
### Connections Types

Specific additional items are used specifically in the usage of Data Connections.
* Labels
* `opendatahub.io/connection-type` - a value of `true` indicates that the `ConfigMap` represents a connection type
* Annotations
* [`openshift.io/display-name`]
* [`openshift.io/description`]
* `opendatahub.io/enabled` - a `true` or `false` value indicates whether the connection type is enabled for use
* `opendatahub.io/username` - the name of the user who created the connection type

### Connections

* Labels
* `opendatahub.io/managed` - helps us define that this is a managed resource by us and not a normal secret
* `opendatahub.io/managed` - helps us define that this is a managed resource by us and not a normal `Secret`
* Annotations
* [`openshift.io/display-name`]
* `opendatahub.io/connection-type` - the type of connection, currently this is only S3
* [`openshift.io/description`]
* `opendatahub.io/connection-type` - a reference to the connection type; eg. `s3`

### ImageStreams

Expand Down

0 comments on commit 25cffe3

Please sign in to comment.