Skip to content

Commit 2a3eadc

Browse files
authored
add api spec docs (#283)
1 parent b26470e commit 2a3eadc

File tree

5 files changed

+4295
-3
lines changed

5 files changed

+4295
-3
lines changed

apis/appmesh/v1beta2/virtualnode_types.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ type VirtualNodeCondition struct {
293293
}
294294

295295
// VirtualNodeSpec defines the desired state of VirtualNode
296-
// refers to https://docs.aws.amazon.com/app-mesh/latest/APIReference/API_VirtualServiceSpec.html
296+
// refers to https://docs.aws.amazon.com/app-mesh/latest/APIReference/API_VirtualNodeSpec.html
297297
type VirtualNodeSpec struct {
298298
// AWSName is the AppMesh VirtualNode object's name.
299299
// If unspecified or empty, it defaults to be "${name}_${namespace}" of k8s VirtualNode

apis/appmesh/v1beta2/virtualservice_types.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ type VirtualServiceCondition struct {
7575
}
7676

7777
// VirtualServiceSpec defines the desired state of VirtualService
78+
// refers to https://docs.aws.amazon.com/app-mesh/latest/APIReference/API_VirtualServiceSpec.html
7879
type VirtualServiceSpec struct {
7980
// AWSName is the AppMesh VirtualService object's name.
8081
// If unspecified or empty, it defaults to be "${name}.${namespace}" of k8s VirtualService

docs/guide/troubleshooting.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ Your can adjust this limit by adjust the "Connected Envoy processes per virtual
99

1010
### Namespaces is not labeled correctly
1111
Namespaces must be labeled with two kind of labels:
12-
* `appmesh.k8s.aws/sidecarInjectorWebhook: enabled` is required on namespaces where pod should be injected with envoy sidecars.
13-
* customized labels to make `mesh` CustomResource selects the namespace via `mesh.spec.namespaceSelector`. (optional if you have a single Mesh selects all namespaces)
12+
13+
* `appmesh.k8s.aws/sidecarInjectorWebhook: enabled` is required on namespaces where pod should be injected with envoy sidecars.
14+
* customized labels to make `mesh` CustomResource selects the namespace via `mesh.spec.namespaceSelector`. (optional if you have a single Mesh selects all namespaces)
1415

1516
## Troubleshooting
1617

0 commit comments

Comments
 (0)