Skip to content

Commit 403a9e7

Browse files
a-hilalya-hilaly
committed
docs: minor UI tweaks and remove unused fields
1 parent 779b9d8 commit 403a9e7

File tree

12 files changed

+63
-176
lines changed

12 files changed

+63
-176
lines changed

‎examples/application/Readme.md‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,66 @@
11
# KRO Application example
2-
This example creates a ResourceGroup called `App` and then instaciates it with the default nginx container image.
2+
3+
This example creates a ResourceGroup called `App` and then instaciates it with
4+
the default nginx container image.
35

46
### Create ResourceGroup called App
7+
58
Apply the RG to your cluster:
9+
610
```
711
kubectl apply -f rg.yaml
812
```
13+
914
Validate the RG status is Active:
15+
1016
```
1117
kubectl get rg app.kro.run
1218
```
19+
1320
Expected result:
21+
1422
```
1523
NAME APIVERSION KIND STATE AGE
1624
app.kro.run v1alpha1 App Active 6m
1725
```
1826

1927
### Create an Instance of kind App
28+
2029
Apply the provided instance.yaml
30+
2131
```
2232
kubectl apply -f instance.yaml
2333
```
34+
2435
Validate instance status:
36+
2537
```
2638
kubectl get apps test-app
2739
```
40+
2841
Expected result:
42+
2943
```
3044
NAME STATE SYNCED AGE
3145
test-app ACTIVE True 16m
3246
```
3347

3448
### Validate the app is working
49+
3550
Get the ingress url:
51+
3652
```
3753
kubectl get ingress test-app -o jsonpath='{.status.loadBalancer.ingress[0].hostname}'
3854
```
3955

4056
Either navigate in the browser or curl it:
57+
4158
```
4259
curl -s $(kubectl get ingress test-app -o jsonpath='{.status.loadBalancer.ingress[0].hostname}') | sed -n '/<body>/,/<\/body>/p' | sed -e 's/<[^>]*>//g'
4360
```
61+
4462
Expected result:
63+
4564
```
4665
Welcome to nginx!
4766
If you see this page, the nginx web server is successfully installed and
@@ -56,11 +75,15 @@ Thank you for using nginx.
5675
```
5776

5877
### Clean up
78+
5979
Remove the instance:
80+
6081
```
6182
kubectl delete apps test-app
6283
```
84+
6385
Remove the resourcegroup:
86+
6487
```
6588
kubectl delete rg app.kro.run
6689
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 1
33
---
44

5-
# 1. ResourceGroups
5+
# ResourceGroups
66

77
**ResourceGroups** are the fundamental building blocks in KRO. They provide a
88
way to define, organize, and manage sets of related Kubernetes resources as a

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 2
33
---
44

5-
# 2. Simple Schema
5+
# Simple Schema
66

77
KRO's Simple Schema provides a powerful yet intuitive way to define the
88
structure of your ResourceGroup. Here is comprehensive example:
@@ -173,13 +173,14 @@ Common condition types include:
173173

174174
### 2. State
175175

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

178179
```yaml
179180
status:
180181
state: string | enum="Ready,Progressing,Degraded,Error,Terminating,Unknown"
181182
```
182183

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

‎website/docs/docs/concepts/15-instances.md‎

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

5-
# 3. Instances
5+
# Instances
66

77
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
@@ -37,8 +37,12 @@ spec:
3737
LOG_LEVEL: debug
3838
```
3939
40-
:::tip The spec fields of an Instance correspond to the parameters defined in the
41-
ResourceGroup. :::
40+
:::
41+
42+
tip The spec fields of an Instance correspond to the parameters defined in the
43+
ResourceGroup.
44+
45+
:::
4246
4347
## The reconciliation loop
4448
@@ -53,8 +57,8 @@ KRO manages Instances through a continuous reconciliation process:
5357
- **State Reconciliation**: KRO takes necessary actions to align the current
5458
state with the desired state. This may involve creating, updating, or deleting
5559
resources as needed.
56-
- **Status Updates**: The Instance's status is updated to reflect the current state
57-
of reconciliation and any issues encountered.
60+
- **Status Updates**: The Instance's status is updated to reflect the current
61+
state of reconciliation and any issues encountered.
5862
- **Continuous Loop**: This process repeats regularly, ensuring the cluster
5963
state always converges towards the desired state defined in the Instance.
6064
@@ -69,16 +73,18 @@ KRO manages Instances through a continuous reconciliation process:
6973
- **Auditability**: The Instance serves as a single source of truth for the
7074
application's desired state.
7175
72-
:::tip Best Practices
76+
:::tip[Best Practices]
7377
74-
- Treat instances as declarative definitions of your application's desired state.
75-
Use version control for your Instances to track changes over time.
78+
- Treat instances as declarative definitions of your application's desired
79+
state. Use version control for your Instances to track changes over time.
7680
- Leverage labels and annotations in Instances for organization and filtering.
7781
- Regularly review Instances to ensure they reflect current requirements.
7882
- Use KRO's dry-run feature to preview reconciliation actions before applying
7983
changes to Instances.
80-
- Monitor Instance statuses to understand the current state of your applications.
81-
:::
84+
- Monitor Instance statuses to understand the current state of your
85+
applications.
86+
87+
:::
8288
8389
## Common Status Fields
8490
@@ -93,8 +99,8 @@ detailed status information. Each condition represents a specific aspect of the
9399
instance's state. Common conditions include:
94100
95101
- **Ready**: Indicates whether the instance is fully reconciled and operational.
96-
- **Progressing**: Shows if the instance is in the process of reaching the desired
97-
state.
102+
- **Progressing**: Shows if the instance is in the process of reaching the
103+
desired state.
98104
- **Degraded**: Signals that the instance is operational but not functioning
99105
optimally.
100106
- **Error**: Indicates that an error has occurred during reconciliation.
@@ -121,8 +127,8 @@ status:
121127
122128
### 2. State
123129
124-
The State field provides a high-level summary of the instance's current status. It
125-
is typically one of the following values:
130+
The State field provides a high-level summary of the instance's current status.
131+
It is typically one of the following values:
126132
127133
- **Pending**: The instance is being processed, but resources are not yet fully
128134
created or configured.
@@ -140,6 +146,6 @@ status:
140146
```
141147
142148
These common status fields provide users with a consistent and informative way
143-
to check the health and state of their instances across different ResourceGroups.
144-
They are essential for monitoring, troubleshooting, and automating operations
145-
based on the status of KRO-managed resources.
149+
to check the health and state of their instances across different
150+
ResourceGroups. They are essential for monitoring, troubleshooting, and
151+
automating operations based on the status of KRO-managed resources.

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

Lines changed: 0 additions & 118 deletions
This file was deleted.

‎website/docs/docs/concepts/30-conditionals.mdx‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎website/docs/docs/concepts/40-imports.mdx‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎website/docs/docs/concepts/50-validation.mdx‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎website/docs/docs/concepts/60-managing-state.mdx‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎website/docs/docs/concepts/_category_.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"label": "Concepts",
33
"position": 40,
44
"link": {
5-
"type": "generated-index",
65
"description": "Learn about the core concepts of KRO"
7-
}
6+
},
7+
"collapsible": true,
8+
"collapsed": false
89
}

0 commit comments

Comments
 (0)