Skip to content

Commit b89222e

Browse files
simonrwsimonrw
committed
Add (versioned) API docs
1 parent 3e49453 commit b89222e

File tree

1 file changed

+166
-0
lines changed

1 file changed

+166
-0
lines changed

‎api-docs.md‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
# API Reference
2+
3+
## Packages
4+
- [api.localstack.cloud/v1alpha1](#apilocalstackcloudv1alpha1)
5+
6+
7+
## api.localstack.cloud/v1alpha1
8+
9+
Package v1alpha1 contains API Schema definitions for the api v1alpha1 API group
10+
11+
### Resource Types
12+
- [LocalStack](#localstack)
13+
- [LocalStackList](#localstacklist)
14+
15+
16+
17+
#### Hooks
18+
19+
20+
21+
22+
23+
24+
25+
_Appears in:_
26+
- [LocalStackSpec](#localstackspec)
27+
28+
| Field | Description | Default | Validation |
29+
| --- | --- | --- | --- |
30+
| `readyConfigName` _string_ | | | Optional: \{\} <br /> |
31+
| `bootConfigName` _string_ | | | Optional: \{\} <br /> |
32+
| `shutdownConfigName` _string_ | | | Optional: \{\} <br /> |
33+
| `startConfigName` _string_ | | | Optional: \{\} <br /> |
34+
35+
36+
#### LicenseServerConfig
37+
38+
39+
40+
41+
42+
43+
44+
_Appears in:_
45+
- [LocalStackSpec](#localstackspec)
46+
47+
| Field | Description | Default | Validation |
48+
| --- | --- | --- | --- |
49+
| `proxies` _object (keys:string, values:string)_ | | \{ \} | Optional: \{\} <br /> |
50+
| `endpoint` _string_ | | https://api.localstack.cloud/v1 | Required: \{\} <br /> |
51+
52+
53+
#### LocalStack
54+
55+
56+
57+
LocalStack is the Schema for the localstacks API
58+
59+
60+
61+
_Appears in:_
62+
- [LocalStackList](#localstacklist)
63+
64+
| Field | Description | Default | Validation |
65+
| --- | --- | --- | --- |
66+
| `apiVersion` _string_ | `api.localstack.cloud/v1alpha1` | | |
67+
| `kind` _string_ | `LocalStack` | | |
68+
| `kind` _string_ | Kind is a string value representing the REST resource this object represents.<br />Servers may infer this from the endpoint the client submits requests to.<br />Cannot be updated.<br />In CamelCase.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | |
69+
| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.<br />Servers should convert recognized schemas to the latest internal value, and<br />may reject unrecognized values.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | |
70+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
71+
| `spec` _[LocalStackSpec](#localstackspec)_ | | | |
72+
| `status` _[LocalStackStatus](#localstackstatus)_ | | | |
73+
74+
75+
#### LocalStackList
76+
77+
78+
79+
LocalStackList contains a list of LocalStack
80+
81+
82+
83+
84+
85+
| Field | Description | Default | Validation |
86+
| --- | --- | --- | --- |
87+
| `apiVersion` _string_ | `api.localstack.cloud/v1alpha1` | | |
88+
| `kind` _string_ | `LocalStackList` | | |
89+
| `kind` _string_ | Kind is a string value representing the REST resource this object represents.<br />Servers may infer this from the endpoint the client submits requests to.<br />Cannot be updated.<br />In CamelCase.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | |
90+
| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.<br />Servers should convert recognized schemas to the latest internal value, and<br />may reject unrecognized values.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | |
91+
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
92+
| `items` _[LocalStack](#localstack) array_ | | | |
93+
94+
95+
#### LocalStackSpec
96+
97+
98+
99+
LocalStackSpec defines the desired state of LocalStack
100+
101+
102+
103+
_Appears in:_
104+
- [LocalStack](#localstack)
105+
106+
| Field | Description | Default | Validation |
107+
| --- | --- | --- | --- |
108+
| `dnsProvider` _string_ | | | Enum: [none coredns] <br />Required: \{\} <br /> |
109+
| `dnsConfigName` _string_ | | | Required: \{\} <br /> |
110+
| `dnsConfigNamespace` _string_ | | | Required: \{\} <br /> |
111+
| `debug` _string_ | | info | Enum: [trace trace-internal debug info warn error warning] <br />Optional: \{\} <br /> |
112+
| `autoLoadPods` _string array_ | | | Optional: \{\} <br /> |
113+
| `authToken` _string_ | | | MaxLength: 39 <br />MinLength: 39 <br />Optional: \{\} <br />Pattern: `^ls-[a-zA-Z0-9]\{8\}-[a-zA-Z0-9]\{4\}-[a-zA-Z0-9]\{4\}-[a-zA-Z0-9]\{4\}-[a-zA-Z0-9]\{12\}$` <br /> |
114+
| `hooks` _[Hooks](#hooks)_ | | | Optional: \{\} <br /> |
115+
| `licenseServerConfig` _[LicenseServerConfig](#licenseserverconfig)_ | | \{ endpoint:https://api.localstack.cloud/v1 \} | Optional: \{\} <br /> |
116+
| `image` _string_ | Validate docker inage name (with optional tag and registry address) | | Pattern: `(?:[a-zA-Z0-9]+(?:[._-][a-zA-Z0-9]+)*\/)?(?:[a-zA-Z0-9]+(?:[._-][a-zA-Z0-9]+)*\/)*[a-zA-Z0-9]+(?:[._-][a-zA-Z0-9]+)*(:[a-zA-Z0-9_.-]+)?` <br />Required: \{\} <br /> |
117+
| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#resourcerequirements-v1-core)_ | | | Optional: \{\} <br /> |
118+
| `readiness_probe` _[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#probe-v1-core)_ | | | Optional: \{\} <br /> |
119+
| `liveness_probe` _[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#probe-v1-core)_ | | | Optional: \{\} <br /> |
120+
| `envFrom` _[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#envfromsource-v1-core) array_ | | | Optional: \{\} <br /> |
121+
| `env` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#envvar-v1-core) array_ | | | Optional: \{\} <br /> |
122+
| `dnsPolicy` _[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#dnspolicy-v1-core)_ | | ClusterFirst | Enum: [Default ClusterFirst ClusterFirstWithHostNet None] <br />Optional: \{\} <br /> |
123+
| `runAsUser` _integer_ | | 0 | Enum: [0 1000] <br />Optional: \{\} <br /> |
124+
125+
126+
#### LocalStackStatus
127+
128+
129+
130+
LocalStackStatus defines the observed state of LocalStack
131+
132+
133+
134+
_Appears in:_
135+
- [LocalStack](#localstack)
136+
137+
| Field | Description | Default | Validation |
138+
| --- | --- | --- | --- |
139+
| `ready` _boolean_ | | | |
140+
| `ip` _string_ | | | |
141+
| `dns` _string_ | | | |
142+
143+
144+
#### PodSpec
145+
146+
147+
148+
149+
150+
151+
152+
_Appears in:_
153+
- [LocalStackSpec](#localstackspec)
154+
155+
| Field | Description | Default | Validation |
156+
| --- | --- | --- | --- |
157+
| `image` _string_ | Validate docker inage name (with optional tag and registry address) | | Pattern: `(?:[a-zA-Z0-9]+(?:[._-][a-zA-Z0-9]+)*\/)?(?:[a-zA-Z0-9]+(?:[._-][a-zA-Z0-9]+)*\/)*[a-zA-Z0-9]+(?:[._-][a-zA-Z0-9]+)*(:[a-zA-Z0-9_.-]+)?` <br />Required: \{\} <br /> |
158+
| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#resourcerequirements-v1-core)_ | | | Optional: \{\} <br /> |
159+
| `readiness_probe` _[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#probe-v1-core)_ | | | Optional: \{\} <br /> |
160+
| `liveness_probe` _[Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#probe-v1-core)_ | | | Optional: \{\} <br /> |
161+
| `envFrom` _[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#envfromsource-v1-core) array_ | | | Optional: \{\} <br /> |
162+
| `env` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#envvar-v1-core) array_ | | | Optional: \{\} <br /> |
163+
| `dnsPolicy` _[DNSPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#dnspolicy-v1-core)_ | | ClusterFirst | Enum: [Default ClusterFirst ClusterFirstWithHostNet None] <br />Optional: \{\} <br /> |
164+
| `runAsUser` _integer_ | | 0 | Enum: [0 1000] <br />Optional: \{\} <br /> |
165+
166+

0 commit comments

Comments
 (0)