Skip to content

Commit c3f73a1

Browse files
candonova-hilaly
authored andcommitted
docs: update instances documentation
1 parent 0f39daa commit c3f73a1

File tree

5 files changed

+55
-55
lines changed

5 files changed

+55
-55
lines changed

website/docs/docs/concepts/00-resource-groups.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,10 @@ controller processes it as follows:
107107
Kubernetes API server, making it available for use in the cluster.
108108
109109
4. **Micro-Controller Deployment**: KRO deploys a dedicated micro-controller for
110-
this ResourceGroup. This micro-controller will listen for **"claim"
110+
this ResourceGroup. This micro-controller will listen for **"instance"
111111
events** - instances of the CRD created in step 2. It will be responsible for
112112
managing the **lifecycle of resources** defined in the ResourceGroup for each
113-
claim.
113+
instance.
114114
115115
5. **Status Update**: The controller updates the status of the ResourceGroup to
116116
reflect that the corresponding CRD has been created and registered.
@@ -125,12 +125,12 @@ associated **Deployments** and **Services** as defined in the ResourceGroup.
125125
The **KRO** controller continues to monitor the **ResourceGroup** for any
126126
changes, updating the corresponding CRD and micro-controller as necessary.
127127

128-
## **ResourceGroup** Claim Example
128+
## **ResourceGroup** Instance Example
129129

130130
After the **ResourceGroup** is processed, users can create instances of it.
131-
Here's an example of how a claim for the `SimpleWebApp` might look:
131+
Here's an example of how an instance for the `SimpleWebApp` might look:
132132

133-
```yaml title="my-web-app-claim.yaml"
133+
```yaml title="my-web-app-instance.yaml"
134134
apiVersion: kro.run/v1alpha1
135135
kind: SimpleWebApp
136136
metadata:

website/docs/docs/concepts/10-simple-schema.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,9 @@ status:
136136

137137
## Default status fields
138138

139-
**KRO** automatically injects two common fields into the status of all claims
139+
**KRO** automatically injects two common fields into the status of all instances
140140
generated from **ResourceGroups**: `conditions` and `state`. These fields
141-
provide essential information about the current status of the claim and its
141+
provide essential information about the current status of the instance and its
142142
associated resources.
143143

144144
:::tip `conditions` and `state` are reserved words in the status section. If a
@@ -148,7 +148,7 @@ override them with its own values. :::
148148
### 1. Conditions
149149

150150
The `conditions` field is an array of condition objects, each representing a
151-
specific aspect of the claim's state. KRO automatically manages this field.
151+
specific aspect of the instance's state. KRO automatically manages this field.
152152

153153
```yaml
154154
status:
@@ -164,22 +164,22 @@ customTypes:
164164

165165
Common condition types include:
166166

167-
- `Ready`: Indicates whether the claim is fully reconciled and operational.
168-
- `Progressing`: Shows if the claim is in the process of reaching the desired
167+
- `Ready`: Indicates whether the instance is fully reconciled and operational.
168+
- `Progressing`: Shows if the instance is in the process of reaching the desired
169169
state.
170-
- `Degraded`: Signals that the claim is operational but not functioning
170+
- `Degraded`: Signals that the instance is operational but not functioning
171171
optimally.
172172
- `Error`: Indicates that an error has occurred during reconciliation.
173173

174174
### 2. State
175175

176-
The `state` field provides a high-level summary of the claim's current status.
176+
The `state` field provides a high-level summary of the instance's current status.
177177

178178
```yaml
179179
status:
180180
state: string | enum="Ready,Progressing,Degraded,Error,Terminating,Unknown"
181181
```
182182

183-
> These default status fields are automatically added to every claim's status,
183+
> These default status fields are automatically added to every instance's status,
184184
> providing a consistent way to check the health and state of resources across
185185
> different **ResourceGroups**.

website/docs/docs/concepts/15-claims.md renamed to website/docs/docs/concepts/15-instances.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22
sidebar_position: 15
33
---
44

5-
# 3. Claims
5+
# 3. Instances
66

7-
Claims are a fundamental concept in **KRO** that represent instances of
7+
Instances are a fundamental concept in **KRO** that represent instances of
88
ResourceGroups. They define the desired state of a set of resources, which KRO
99
continuously works to maintain.
1010

11-
## What is a Claim?
11+
## What is an Instance?
1212

13-
A Claim is a Kubernetes custom resource that:
13+
An Instance is a Kubernetes custom resource that:
1414

1515
- References a specific ResourceGroup
1616
- Provides values for the parameters defined in the ResourceGroup
1717
- Represents the desired state of a set of Kubernetes resources
1818

19-
## Anatomy of a Claim
19+
## Anatomy of an Instance
2020

21-
Here's an example of a Claim for a `WebApplication` ResourceGroup:
21+
Here's an example of an Instance for a `WebApplication` ResourceGroup:
2222

2323
```yaml
2424
apiVersion: kro.run/v1alpha1
@@ -37,65 +37,65 @@ spec:
3737
LOG_LEVEL: debug
3838
```
3939
40-
:::tip The spec fields of a Claim correspond to the parameters defined in the
40+
:::tip The spec fields of an Instance correspond to the parameters defined in the
4141
ResourceGroup. :::
4242
4343
## The reconciliation loop
4444
45-
KRO manages Claims through a continuous reconciliation process:
45+
KRO manages Instances through a continuous reconciliation process:
4646
47-
- **Desired state detection**: KRO observes the Claim, which represents the
47+
- **Desired state detection**: KRO observes the Instance, which represents the
4848
desired state of resources.
4949
- **Current state assessment**: KRO talks to the api-server and checks the
50-
current state of resources in the cluster related to the Claim.
50+
current state of resources in the cluster related to the Instance.
5151
- **Difference identification**: Any differences between the desired state
52-
(Claim) and the current state are identified.
52+
(Instance) and the current state are identified.
5353
- **State Reconciliation**: KRO takes necessary actions to align the current
5454
state with the desired state. This may involve creating, updating, or deleting
5555
resources as needed.
56-
- **Status Updates**: The Claim's status is updated to reflect the current state
56+
- **Status Updates**: The Instance's status is updated to reflect the current state
5757
of reconciliation and any issues encountered.
5858
- **Continuous Loop**: This process repeats regularly, ensuring the cluster
59-
state always converges towards the desired state defined in the Claim.
59+
state always converges towards the desired state defined in the Instance.
6060
6161
## Advantages of declarative management [need better title]
6262
6363
- **Declarative Management**: Users define what they want, not how to get there.
6464
- **Self-healing**: The system continuously works to maintain the desired state.
65-
- **Idempotency**: The same Claim always results in the same end state,
65+
- **Idempotency**: The same Instance always results in the same end state,
6666
regardless of the current state.
6767
- **Abstraction**: Complex resource relationships are managed behind the scenes.
6868
- **Consistency**: All resources for an application are managed as a unit.
69-
- **Auditability**: The Claim serves as a single source of truth for the
69+
- **Auditability**: The Instance serves as a single source of truth for the
7070
application's desired state.
7171
7272
:::tip Best Practices
7373
74-
- Treat claims as declarative definitions of your application's desired state.
75-
Use version control for your Claims to track changes over time.
76-
- Leverage labels and annotations in Claims for organization and filtering.
77-
- Regularly review Claims to ensure they reflect current requirements.
74+
- Treat instances as declarative definitions of your application's desired state.
75+
Use version control for your Instances to track changes over time.
76+
- Leverage labels and annotations in Instances for organization and filtering.
77+
- Regularly review Instances to ensure they reflect current requirements.
7878
- Use KRO's dry-run feature to preview reconciliation actions before applying
79-
changes to Claims.
80-
- Monitor Claim statuses to understand the current state of your applications.
79+
changes to Instances.
80+
- Monitor Instance statuses to understand the current state of your applications.
8181
:::
8282
8383
## Common Status Fields
8484
85-
KRO automatically injects two common fields into the status of all claims:
85+
KRO automatically injects two common fields into the status of all instances:
8686
**Conditions** and **State**. These fields provide crucial information about the
87-
current status of the claim and its associated resources.
87+
current status of the instance and its associated resources.
8888
8989
### 1. Conditions
9090
9191
Conditions are a standard Kubernetes concept that KRO leverages to provide
9292
detailed status information. Each condition represents a specific aspect of the
93-
claim's state. Common conditions include:
93+
instance's state. Common conditions include:
9494
95-
- **Ready**: Indicates whether the claim is fully reconciled and operational.
96-
- **Progressing**: Shows if the claim is in the process of reaching the desired
95+
- **Ready**: Indicates whether the instance is fully reconciled and operational.
96+
- **Progressing**: Shows if the instance is in the process of reaching the desired
9797
state.
98-
- **Degraded**: Signals that the claim is operational but not functioning
98+
- **Degraded**: Signals that the instance is operational but not functioning
9999
optimally.
100100
- **Error**: Indicates that an error has occurred during reconciliation.
101101
@@ -121,16 +121,16 @@ status:
121121
122122
### 2. State
123123
124-
The State field provides a high-level summary of the claim's current status. It
124+
The State field provides a high-level summary of the instance's current status. It
125125
is typically one of the following values:
126126
127-
- **Pending**: The claim is being processed, but resources are not yet fully
127+
- **Pending**: The instance is being processed, but resources are not yet fully
128128
created or configured.
129-
- **Running**: All resources are created and the claim is operational.
130-
- **Failed**: An error occurred and the claim could not be fully reconciled.
131-
- **Terminating**: The claim is in the process of being deleted.
132-
- **Degraded**: The claim is operational but not functioning optimally.
133-
- **Unknown**: The claim's status cannot be determined.
129+
- **Running**: All resources are created and the instance is operational.
130+
- **Failed**: An error occurred and the instance could not be fully reconciled.
131+
- **Terminating**: The instance is in the process of being deleted.
132+
- **Degraded**: The instance is operational but not functioning optimally.
133+
- **Unknown**: The instance's status cannot be determined.
134134
135135
Example:
136136
@@ -140,6 +140,6 @@ status:
140140
```
141141
142142
These common status fields provide users with a consistent and informative way
143-
to check the health and state of their claims across different ResourceGroups.
143+
to check the health and state of their instances across different ResourceGroups.
144144
They are essential for monitoring, troubleshooting, and automating operations
145145
based on the status of KRO-managed resources.

website/docs/docs/concepts/20-collections.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ based on the `podCount` parameter.
5959
2. **definition**: Defines the structure of each resource instance in the
6060
collection. The `${index}` variable ensures uniqueness of each resource.
6161

62-
## Using Collections in Claims
62+
## Using Collections in Instances
6363

64-
When creating a claim, users can specify the count for the collection:
64+
When creating an instance, users can specify the count for the collection:
6565

6666
```yaml
6767
apiVersion: kro.run/v1alpha1
@@ -73,7 +73,7 @@ spec:
7373
podCount: 3
7474
```
7575

76-
This claim will result in the creation of three Postgres Pods named
76+
This instance will result in the creation of three Postgres Pods named
7777
`production-db-node-0`, `production-db-node-1`, and `production-db-node-2`.
7878

7979
## Deployment Strategy

website/docs/docs/getting-started/02-deploy-a-resource-group.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,11 @@ spec:
9292
deployment-service v1alpha1 DeploymentService ACTIVE 16m
9393
```
9494

95-
4. **Install a resource group claim**: Create a claim for the resource group you
96-
just deployed. Claims are used to define the desired state of the resources
95+
4. **Install a resource group instance**: Create an instance for the resource group you
96+
just deployed. Instances are used to define the desired state of the resources
9797
in the ResourceGroup.
9898

99-
Here's an example of a Claim for the `EKSCluster` ResourceGroup:
99+
Here's an example of an Instance for the `EKSCluster` ResourceGroup:
100100

101101
```yaml
102102
apiVersion: kro.run/v1alpha1
@@ -107,5 +107,5 @@ spec:
107107
name: app1
108108
```
109109

110-
The spec fields of a Claim correspond to the parameters defined in the
110+
The spec fields of an Instance correspond to the parameters defined in the
111111
ResourceGroup.

0 commit comments

Comments
 (0)