Skip to content
Permalink
Browse files

docs: update doc

Related to issue #261
  • Loading branch information...
aureamunoz authored and iocanel committed Jul 23, 2019
1 parent 25f210c commit 05690f729e72adac6c4e1545ea017b5f4c8575c3
Showing with 37 additions and 24 deletions.
  1. +35 −22 config.md
  2. +1 −1 design.md
  3. +1 −1 readme.md
@@ -97,12 +97,6 @@ For example to reference the `httpActionPath` of the complex object `Probe` whic

### Openshift types

#### BuildConfig
| Property | Type | Description | Default Value |
|----------|--------|-------------|---------------|
| type | String | | s2i |


## Component

| Property | Type | Description | Default Value |
@@ -111,8 +105,8 @@ For example to reference the `httpActionPath` of the complex object `Probe` whic
| dekorate.component.deploymentMode | DeploymentMode | | dev |
| dekorate.component.exposeService | boolean | | false |
| dekorate.component.envs | io.dekorate.kubernetes.annotation.Env[] | | |
| dekorate.component.buildconfig | io.dekorate.kubernetes.annotation.BuildConfig | | @io.dekorate.kubernetes.annotation.BuildConfig |
| dekorate.component.remote | String | | |
| dekorate.component.buildType | String | | s2i |
| dekorate.component.remote | String | | origin |

#### Link
| Property | Type | Description | Default Value |
@@ -122,6 +116,15 @@ For example to reference the `httpActionPath` of the complex object `Probe` whic
| kind | Kind | | Env |
| ref | String | | |
| envs | io.dekorate.kubernetes.annotation.Env[] | | |

#### Capability
| Property | Type | Description | Default Value |
|------------|-------------|-------------|---------------|
| category | String | | |
| kind | String | | |
| name | String | | |
| version | String | | |
| parameters | Parameter[] | | |
#
## Global Types

@@ -189,7 +192,7 @@ The section below describes all the avialables subtypes
|-------------|---------|-------------|---------------|
| volumeName | String | | |
| secretName | String | | |
| defaultMode | int | | 0600 |
| defaultMode | int | | 384 |
| optional | boolean | | false |

#### AzureDiskVolume
@@ -202,6 +205,13 @@ The section below describes all the avialables subtypes
| cachingMode | String | | ReadWrite |
| fsType | String | | ext4 |
| readOnly | boolean | | false |
####AzureFileVolume
| Property | Type | Description | Default Value |
|-- ---------- | --------- | ------------- | ------------- --|
| volumeName | String | | |
| shareName | String | | |
| secretName | String | | |
| readOnly | boolean | | false |
#### AwsElasticBlockStoreVolume
| Property | Type | Description | Default Value |
|------------|---------|-------------|---------------|
@@ -223,18 +233,21 @@ The section below describes all the avialables subtypes
| volumeName | String | | |
| claimName | String | | |
| readOnly | boolean | | false |
#### AzureFileVolume
| Property | Type | Description | Default Value |
|------------|---------|-------------|---------------|
| volumeName | String | | |
| shareName | String | | |
| secretName | String | | |
| readOnly | boolean | | false |
#### AzureDiskVolume
| Property | Type | Description | Default Value |
|-- ---------- | --------- | ------------- | ------------- --|
| volumeName | String | | |
| diskName | String | | |
| diskURI | String | | |
| kind | String | | Managed |
| cachingMode | String | | ReadWrite |
| fsType | String | | ext4 |
| readOnly | boolean | | false |
#### ConfigMapVolume
| Property | Type | Description | Default Value |
|---------------|---------|-------------|---------------|
| volumeName | String | | |
| configMapName | String | | |
| defaultMode | int | | 0600 |
| optional | boolean | | false |
| Property | Type | Description | Default Value |
|-- ------------- | --------- | ------------- | ------------- --|
| volumeName | String | | |
| configMapName | String | | |
| defaultMode | int | | 384 |
| optional | boolean | | false |

@@ -16,7 +16,7 @@ The handlers role is to create or modify the `model` based on the `config`.

Finally, the `model` is serialized to disk as json/yml.

[![sequence diagram](https://raw.githubusercontent.com/dekorate/dekorate/master/doc/src/main/resources/sequence.png)]
[![sequence diagram](https://raw.githubusercontent.com/dekorateio/dekorate/master/doc/src/main/resources/sequence.png)]

## Vocabulary

@@ -107,7 +107,7 @@ public class Main {
```

When the project gets compiled, the annotation will trigger the generation of a `Deployment` in both json and yml that
will end up under 'target/classes/META-INF/apk'.
will end up under 'target/classes/META-INF/dekorate'.

The annotation comes with a lot of parameters, which can be used in order to customize the `Deployment` and/or trigger
the generations of addition resources, like `Service` and `Ingress`.

0 comments on commit 05690f7

Please sign in to comment.
You can’t perform that action at this time.