Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
avirtopeanu-ionos committed Jan 26, 2024
1 parent 246601b commit 0a8e7fa
Show file tree
Hide file tree
Showing 22 changed files with 1,648 additions and 2,164 deletions.
295 changes: 130 additions & 165 deletions docs/api/application-load-balancer/applicationloadbalancer.md

Large diffs are not rendered by default.

385 changes: 170 additions & 215 deletions docs/api/application-load-balancer/forwardingrule.md

Large diffs are not rendered by default.

82 changes: 33 additions & 49 deletions docs/api/application-load-balancer/targetgroup.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
description: Manages TargetGroup Resource on IONOS Cloud.
---

# TargetGroup Managed Resource

## Overview

* Resource Name: `TargetGroup`
Expand Down Expand Up @@ -78,58 +72,48 @@ In order to configure the IONOS Cloud Resource, the user can set the `spec.forPr
* possible values: "ROUND_ROBIN";"LEAST_CONNECTION";"RANDOM";"SOURCE_IP"
* `healthCheck` (object)
* description: Health check properties for target group.
* properties:
* `checkInterval` (integer)
* description: The interval in milliseconds between consecutive health checks; default is 2000.
* format: int32
* `checkTimeout` (integer)
* description: The maximum time in milliseconds to wait for a target to respond to a check. For target VMs with 'Check Interval' set, the lesser of the two values is used once the TCP connection is established.
* format: int32
* `retries` (integer)
* description: The maximum number of attempts to reconnect to a target after a connection failure. Valid range is 0 to 65535, and default is three reconnection attempts.
* format: int32
* `checkInterval` (integer)
* description: The interval in milliseconds between consecutive health checks; default is 2000.
* format: int32
* `checkTimeout` (integer)
* description: The maximum time in milliseconds to wait for a target to respond to a check. For target VMs with 'Check Interval' set, the lesser of the two values is used once the TCP connection is established.
* format: int32
* `retries` (integer)
* description: The maximum number of attempts to reconnect to a target after a connection failure. Valid range is 0 to 65535, and default is three reconnection attempts.
* format: int32
* `httpHealthCheck` (object)
* description: HTTP health check properties for target group.
* properties:
* `matchType` (string)
* description: The match type for the HTTP health check.
* possible values: "";"STATUS_CODE";"RESPONSE_BODY"
* `method` (string)
* description: The method for the HTTP health check.
* possible values: "HEAD";"PUT";"POST";"GET";"TRACE";"PATCH";"OPTIONS"
* `negate` (boolean)
* `path` (string)
* description: The path (destination URL) for the HTTP health check request; the default is `/`.
* `regex` (boolean)
* `response` (string)
* description: The response returned by the request, depending on the match type.
* required properties:
* `matchType`
* `response`
* `matchType` (string)
* description: The match type for the HTTP health check.
* possible values: "";"STATUS_CODE";"RESPONSE_BODY"
* `method` (string)
* description: The method for the HTTP health check.
* possible values: "HEAD";"PUT";"POST";"GET";"TRACE";"PATCH";"OPTIONS"
* `negate` (boolean)
* `path` (string)
* description: The path (destination URL) for the HTTP health check request; the default is `/`.
* `regex` (boolean)
* `response` (string)
* description: The response returned by the request, depending on the match type.
* `name` (string)
* description: The name of the target group.
* `protocol` (string)
* description: Balancing protocol.
* possible values: "HTTP"
* `targets` (array)
* description: Array of items in the collection.
* properties:
* `maintenanceEnabled` (boolean)
* description: Maintenance mode prevents the target from receiving balanced traffic.
* `port` (integer)
* description: The port of the balanced target service; valid range is 1 to 65535.
* format: int32
* `weight` (integer)
* description: Traffic is distributed in proportion to target weight, relative to the combined weight of all targets. A target with higher weight receives a greater share of traffic. Valid range is 0 to 256 and default is 1; targets with weight of 0 do not participate in load balancing but still accept persistent connections. It is best use values in the middle of the range to leave room for later adjustments.
* format: int32
* `healthCheckEnabled` (boolean)
* description: Makes the target available only if it accepts periodic health check TCP connection attempts; when turned off, the target is considered always available. The health check only consists of a connection attempt to the address and port of the target.
* `ip` (string)
* description: The IP of the balanced target VM.
* required properties:
* `ip`
* `port`
* `weight`
* `healthCheckEnabled` (boolean)
* description: Makes the target available only if it accepts periodic health check TCP connection attempts; when turned off, the target is considered always available. The health check only consists of a connection attempt to the address and port of the target.
* `ip` (string)
* description: The IP of the balanced target VM.
* `maintenanceEnabled` (boolean)
* description: Maintenance mode prevents the target from receiving balanced traffic.
* `port` (integer)
* description: The port of the balanced target service; valid range is 1 to 65535.
* format: int32
* `weight` (integer)
* description: Traffic is distributed in proportion to target weight, relative to the combined weight of all targets. A target with higher weight receives a greater share of traffic. Valid range is 0 to 256 and default is 1; targets with weight of 0 do not participate in load balancing but still accept persistent connections. It is best use values in the middle of the range to leave room for later adjustments.
* format: int32

### Required Properties

Expand Down
Loading

0 comments on commit 0a8e7fa

Please sign in to comment.