Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to core.Dogu compendium #72

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
37 changes: 25 additions & 12 deletions docs/core/compendium_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ represents the `dogu.json`.



## type [ConfigurationField](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L320-L395>)
## type [ConfigurationField](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L321-L396>)

ConfigurationField describes a single dogu configuration field which is stored in the Cloudogu EcoSystem registry.

Expand Down Expand Up @@ -128,7 +128,7 @@ Example:
}
```

## type [Dependency](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L454-L503>)
## type [Dependency](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L455-L504>)

Dependency describes the quality of a dogu dependency towards another entity.

Expand Down Expand Up @@ -213,7 +213,7 @@ Example:

- "<=0.0.0" - prohibit the selected entity being present

## type [Dogu](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L544-L989>)
## type [Dogu](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L545-L1000>)

Dogu describes properties of a containerized application for the Cloudogu EcoSystem. Besides the meta information and the [OCI container image](https://opencontainers.org/), Dogu describes all necessities for automatic container instantiation, f. i. volumes, dependencies towards other dogus, and much more.

Expand Down Expand Up @@ -259,6 +259,8 @@ type Dogu struct {

Version string

PublishedAt time.Time

DisplayName string

Description string
Expand Down Expand Up @@ -354,6 +356,17 @@ NAME="official/nginx" \
VERSION="1.23.2-1"
```

### PublishedAt

PublishedAt is the date and time when the dogu was created.

This field does not need to be filled in by the developer. The dogu.cloudogu.com service automatically replaces the content with the current time when the new dogu is created.

Examples:

- 2024-10-16T07:49:34.738Z
- 2019-05-03T13:31:48.612Z

### DisplayName

DisplayName is the name of the dogu which is used in UI frontends to represent the dogu. This field is mandatory.
Expand Down Expand Up @@ -730,15 +743,15 @@ Examples:
]
```

## type [DoguJsonV2FormatProvider](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L1215>)
## type [DoguJsonV2FormatProvider](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L1228>)

DoguJsonV2FormatProvider provides methods to format Dogu results compatible to v2 API.

```go
type DoguJsonV2FormatProvider struct{}
```

## type [EnvironmentVariable](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L280-L283>)
## type [EnvironmentVariable](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L281-L284>)

EnvironmentVariable struct represents custom parameters that can change the behaviour of a dogu build process

Expand All @@ -751,7 +764,7 @@ type EnvironmentVariable struct {



## type [ExposedCommand](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L243-L276>)
## type [ExposedCommand](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L244-L277>)

ExposedCommand struct represents a command which can be executed inside the dogu

Expand Down Expand Up @@ -804,7 +817,7 @@ Examples:
- /resources/create-sa.sh
- /resources/deletePlugin.sh

## type [ExposedPort](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L204-L231>)
## type [ExposedPort](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L205-L232>)

ExposedPort struct is used to define ports which are exported to the host.

Expand Down Expand Up @@ -855,7 +868,7 @@ Examples:
- 8080
- 65535

## type [HealthCheck](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L171-L196>)
## type [HealthCheck](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L172-L197>)

HealthCheck provide readiness and health checks for the dogu container.

Expand Down Expand Up @@ -903,7 +916,7 @@ Deprecated: is not in use.



## type [ServiceAccount](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L299-L317>)
## type [ServiceAccount](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L300-L318>)

ServiceAccount struct can be used to get access to another dogu.

Expand Down Expand Up @@ -945,7 +958,7 @@ Kind defines the kind of service on which the account should be created, e.g. `d

Reading this property and creating a corresponding service account is up to the client.

## type [ValidationDescriptor](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L398-L411>)
## type [ValidationDescriptor](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L399-L412>)

ValidationDescriptor describes how to determine if a config value is valid.

Expand All @@ -969,7 +982,7 @@ Type contains the name of the config value validator. This field is mandatory. V

Values may contain values that aid the selected validator. The values may or may not be optional, depending on the Type being used. It is up to the selected validator whether this field is mandatory, optional, or unused.

## type [Volume](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L74-L136>)
## type [Volume](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L75-L137>)

Volume defines container volumes that are created during the dogu creation or upgrade.

Expand Down Expand Up @@ -1059,7 +1072,7 @@ NeedsBackup controls whether the Cloudogu EcoSystem backup facility backs up the

Clients contains a list of client-specific (t. i., the client that interprets the dogu.json) configurations for the volume. This field is optional.

## type [VolumeClient](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L58-L67>)
## type [VolumeClient](<https://github.com/cloudogu/cesapp-lib/blob/main/core/dogu_v2.go#L59-L68>)

VolumeClient adds additional information for clients to create volumes.

Expand Down