Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved descriptions, updated dependencies #2

Merged
merged 1 commit into from
Jan 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@
page_title: "liqo Provider"
subcategory: ""
description: |-
Interact with Liqo.
Liqo provider to enable seamless and secure resource sharing between multiple
Kubernetes clusters, creating a single virtual cluster that spans across
multiple physical ones.
---

# liqo Provider

Interact with Liqo.
Liqo provider to enable seamless and secure resource sharing between multiple
Kubernetes clusters, creating a single virtual cluster that spans across
multiple physical ones.

## Example Usage

Expand Down
12 changes: 9 additions & 3 deletions docs/resources/generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,18 @@
page_title: "liqo_generate Resource - liqo"
subcategory: ""
description: |-
Generate peering parameters for remote clusters
It retrieves the information concerning the local
cluster (i.e., authentication endpoint and token, cluster ID, ...) to use
on a different cluster to establish an out-of-band outgoing
peering towards the local cluster.
---

# liqo_generate (Resource)

Generate peering parameters for remote clusters
It retrieves the information concerning the local
cluster (i.e., authentication endpoint and token, cluster ID, ...) to use
on a different cluster to establish an out-of-band outgoing
peering towards the local cluster.



Expand All @@ -17,7 +23,7 @@ Generate peering parameters for remote clusters

### Optional

- `liqo_namespace` (String) Namespace where is Liqo installed in provider cluster.
- `liqo_namespace` (String) Namespace where Liqo is installed in provider cluster.

### Read-Only

Expand Down
14 changes: 9 additions & 5 deletions docs/resources/offload.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@
page_title: "liqo_offload Resource - liqo"
subcategory: ""
description: |-
Offload a namespace.
Once a given namespace is selected for offloading, `Offload resource` extends
it across the cluster boundaries, through the the automatic creation of
twin namespaces in the selected remote clusters.
---

# liqo_offload (Resource)

Offload a namespace.
Once a given namespace is selected for offloading, `Offload resource` extends
it across the cluster boundaries, through the the automatic creation of
twin namespaces in the selected remote clusters.



Expand All @@ -17,20 +21,20 @@ Offload a namespace.

### Required

- `namespace` (String) Offload a namespace.
- `namespace` (String) Namespace to offload.

### Optional

- `cluster_selector_terms` (Attributes List) Selectors to restrict the set of remote clusters. (see [below for nested schema](#nestedatt--cluster_selector_terms))
- `namespace_mapping_strategy` (String) Naming strategy used to create the remote namespace.
- `pod_offloading_strategy` (String) Namespace to offload.
- `pod_offloading_strategy` (String) High-level constraints with respect to the pod offloading strategy (e.g., _remote_ vs _local_).

<a id="nestedatt--cluster_selector_terms"></a>
### Nested Schema for `cluster_selector_terms`

Optional:

- `match_expressions` (Attributes List) A list of cluster selector. (see [below for nested schema](#nestedatt--cluster_selector_terms--match_expressions))
- `match_expressions` (Attributes List) A list of cluster selectors. (see [below for nested schema](#nestedatt--cluster_selector_terms--match_expressions))

<a id="nestedatt--cluster_selector_terms--match_expressions"></a>
### Nested Schema for `cluster_selector_terms.match_expressions`
Expand Down
20 changes: 13 additions & 7 deletions docs/resources/peer.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,18 @@
page_title: "liqo_peer Resource - liqo"
subcategory: ""
description: |-
Execute peering.
It enables a Liqo peering, i.e., a unidirectional resource and service consumption
relationship between two Kubernetes clusters, with one cluster (i.e., the
consumer) granted the capability to offload tasks in a remote cluster (i.e., the
provider), but not vice versa.
---

# liqo_peer (Resource)

Execute peering.
It enables a Liqo peering, i.e., a unidirectional resource and service consumption
relationship between two Kubernetes clusters, with one cluster (i.e., the
consumer) granted the capability to offload tasks in a remote cluster (i.e., the
provider), but not vice versa.



Expand All @@ -17,13 +23,13 @@ Execute peering.

### Required

- `cluster_authurl` (String) Provider authentication url used for peering.
- `cluster_id` (String) Provider cluster ID used for peering.
- `cluster_name` (String) Provider cluster name used for peering.
- `cluster_token` (String) Provider authentication token used for peering.
- `cluster_authurl` (String) Provider authentication url.
- `cluster_id` (String) Provider cluster ID.
- `cluster_name` (String) Provider cluster name.
- `cluster_token` (String) Provider authentication token.

### Optional

- `liqo_namespace` (String) Namespace where is Liqo installed in provider cluster.
- `liqo_namespace` (String) Namespace where Liqo is installed in the provider cluster.