Skip to content

Commit

Permalink
docs: update gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Mar 7, 2024
1 parent f4a9208 commit 0dad432
Show file tree
Hide file tree
Showing 2 changed files with 123 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ Below are the different versions of Custom Resource Definitions:
- [v0.4.0](./v0.4.0.md)
- [v0.5.0](./v0.5.0.md)
- [v0.5.0](./v0.5.0.md)
- [v0.5.0](./v0.5.0.md)
122 changes: 122 additions & 0 deletions docs/v0.5.0.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,13 @@ Auto-generated derived type for NimbleSpec via `CustomResource`
<br/>
</td>
<td>true</td>
</tr><tr>
<td><b><a href="#nimblespecservice">service</a></b></td>
<td>object</td>
<td>
<br/>
</td>
<td>false</td>
</tr></tbody>
</table>

Expand Down Expand Up @@ -776,3 +783,118 @@ TCPSocket specifies an action involving a TCP port.
<td>true</td>
</tr></tbody>
</table>


### Nimble.spec.service
<sup><sup>[↩ Parent](#nimblespec)</sup></sup>





<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>annotations</b></td>
<td>map[string]string</td>
<td>
Annotations to be applied to the service.<br/>
<br/>
<i>Default</i>: map[app.kubernetes.io/managed-by:kube-nimble]<br/>
</td>
<td>false</td>
</tr><tr>
<td><b><a href="#nimblespecserviceportsindex">ports</a></b></td>
<td>[]object</td>
<td>
The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>selector</b></td>
<td>map[string]string</td>
<td>
Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>type</b></td>
<td>string</td>
<td>
type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. “ClusterIP” allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is “None”, no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. “NodePort” builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. “LoadBalancer” builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. “ExternalName” aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types<br/>
<br/>
<i>Default</i>: ClusterIP<br/>
</td>
<td>false</td>
</tr></tbody>
</table>


### Nimble.spec.service.ports[index]
<sup><sup>[↩ Parent](#nimblespecservice)</sup></sup>





<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>port</b></td>
<td>integer</td>
<td>
The port that will be exposed by this service.<br/>
<br/>
<i>Format</i>: int32<br/>
</td>
<td>true</td>
</tr><tr>
<td><b>name</b></td>
<td>string</td>
<td>
The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the ‘name’ field in the EndpointPort. Optional if only one ServicePort is defined on this service.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>nodePort</b></td>
<td>integer</td>
<td>
The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport<br/>
<br/>
<i>Format</i>: int32<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>protocol</b></td>
<td>string</td>
<td>
The IP protocol for this port. Supports “TCP”, “UDP”, and “SCTP”. Default is TCP.<br/>
<br/>
<i>Default</i>: TCP<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>targetPort</b></td>
<td>integer</td>
<td>
Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod’s container ports. If this is not specified, the value of the ‘port’ field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the ‘port’ field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service<br/>
<br/>
<i>Format</i>: int32<br/>
</td>
<td>false</td>
</tr></tbody>
</table>

0 comments on commit 0dad432

Please sign in to comment.