|
| 1 | +# sqldef plugin |
| 2 | + |
| 3 | +| Metadata | | |
| 4 | +| ------------- |-----------| |
| 5 | +|[Stability](/README.md#stability-levels) | In Development | |
| 6 | +| Issues | [](https://github.com/pipe-cd/community-plugins/issues?q=is%3Aopen+is%3Aissue+label%3Aplugin%2Fsqldef) | |
| 7 | +| [Code Owners](/CONTRIBUTING.md#becoming-a-code-owner) | [@kadai0308](https://github.com/@kadai0308) | |
| 8 | + |
| 9 | +## Supported Features |
| 10 | +<!-- |
| 11 | +- QuickSync |
| 12 | +- PipelineSync |
| 13 | +- Prune |
| 14 | +- LiveState View |
| 15 | +- DriftDetection |
| 16 | +- PlanPreview |
| 17 | +--> |
| 18 | + |
| 19 | +<!-- You can add additional rows like 'PipelineSync by Istio', 'Analysis by <some-o11y-provider>', etc. --> |
| 20 | + |
| 21 | +<!-- For a stages plugin, only PipelineSync would be supported in most cases. --> |
| 22 | + |
| 23 | +## Overview |
| 24 | + |
| 25 | +<!-- e.g. This is a plugin for deploying xxx. --> |
| 26 | + |
| 27 | +## Stages |
| 28 | + |
| 29 | +<!-- ### XXX stage --> |
| 30 | +<!-- e.g. This stage shows a message on UI. --> |
| 31 | + |
| 32 | +<!-- ### YYY stage --> |
| 33 | + |
| 34 | +## Plugin Configuration |
| 35 | + |
| 36 | +### Plugin scope config |
| 37 | + |
| 38 | +<!-- |
| 39 | +Plugin scope config means 'HERE': |
| 40 | +
|
| 41 | +```yaml |
| 42 | +kind: Piped |
| 43 | +spec: |
| 44 | + plugins: |
| 45 | + - name: xxx |
| 46 | + port: 7002 |
| 47 | + url: https://... |
| 48 | + config: # <-------- HERE |
| 49 | + aaa: ... |
| 50 | + bbb: ... |
| 51 | + deployTargets: |
| 52 | + - name: cluster1 |
| 53 | + ... |
| 54 | +``` |
| 55 | +
|
| 56 | +| Field | Type | Description | Required | Default | |
| 57 | +|-|-|-|-|-| |
| 58 | +| aaa | string | ... | Yes | | |
| 59 | +| bbb | map[string]string | ... | No | | |
| 60 | +
|
| 61 | +--> |
| 62 | + |
| 63 | +### Deploy Target config |
| 64 | + |
| 65 | +<!-- |
| 66 | +Deploy Target config means 'HERE': |
| 67 | +
|
| 68 | +```yaml |
| 69 | +kind: Piped |
| 70 | +spec: |
| 71 | + plugins: |
| 72 | + - name: xxx |
| 73 | + port: 7002 |
| 74 | + config: |
| 75 | + ... |
| 76 | + deployTargets: |
| 77 | + - name: cluster1 |
| 78 | + config: # <-------- HERE |
| 79 | + ppp: ... |
| 80 | + qqq: ... |
| 81 | + - name: cluster2 |
| 82 | + config: ... |
| 83 | +``` |
| 84 | +
|
| 85 | +| Field | Type | Description | Required | Default | |
| 86 | +|-|-|-|-|-| |
| 87 | +| ppp | string | ... | Yes | | |
| 88 | +| qqq | map[string]string | ... | No | | |
| 89 | +
|
| 90 | +--> |
| 91 | + |
| 92 | + |
| 93 | +## Application Configuration |
| 94 | + |
| 95 | +### Application scope options |
| 96 | +<!-- |
| 97 | +'Application scope options' means 'HERE': |
| 98 | +
|
| 99 | +```yaml |
| 100 | +kind: Application |
| 101 | +spec: |
| 102 | + plugins: |
| 103 | + xxx: |
| 104 | + - name: xxx |
| 105 | + with: # <-------- HERE |
| 106 | + name: ... |
| 107 | + labels: ... |
| 108 | + some: ... |
| 109 | +``` |
| 110 | +--> |
| 111 | + |
| 112 | +### Stage options |
| 113 | +<!-- |
| 114 | +
|
| 115 | +'Stage options' means 'HERE': |
| 116 | +```yaml |
| 117 | +kind: Application |
| 118 | +spec: |
| 119 | + pipeline: |
| 120 | + stages: |
| 121 | + - name: xxx |
| 122 | + with: # <-------- HERE |
| 123 | + name: ... |
| 124 | + labels: ... |
| 125 | + some: ... |
| 126 | +``` |
| 127 | +
|
| 128 | +#### XXX stage |
| 129 | +
|
| 130 | +| Field | Type | Description | Required | Default | |
| 131 | +|-|-|-|-|-| |
| 132 | +| name | string | The name to be shown in the stage. | Yes | |
| 133 | +| labels | map[string]string | ... | No | | |
| 134 | +| some | [yourtype](#yourtype) | ... | No | | |
| 135 | +
|
| 136 | +##### yourtype |
| 137 | +
|
| 138 | +| Field | Type | Description | Required | Default | |
| 139 | +|-|-|-|-|-| |
| 140 | +| aaa | bool | ... | No | false | |
| 141 | +| bbb | int | ... | No | 0 | |
| 142 | +
|
| 143 | +#### YYY stage |
| 144 | +
|
| 145 | +| Field | Type | Description | Required | Default | |
| 146 | +|-|-|-|-|-| |
| 147 | +| messages | []string | The messages to be shown in the stage. | No | [""] | |
| 148 | +
|
| 149 | +--> |
| 150 | + |
| 151 | +<!-- You can add additional sections if needed. --> |
0 commit comments