Skip to content

Commit e8f5118

Browse files
committed
docs: fix RGD abbreviations in docs
Update documentation to consistently use "RGD" (Resource Graph Definition) instead of "RG"
1 parent 566af77 commit e8f5118

File tree

7 files changed

+36
-22
lines changed

7 files changed

+36
-22
lines changed

examples/aws/eks-cluster-mgmt/clusters/rg/vpc.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ spec:
2424
publicSubnet2ID: ${publicSubnet2.status.subnetID}
2525
privateSubnet1ID: ${privateSubnet1.status.subnetID}
2626
privateSubnet2ID: ${privateSubnet2.status.subnetID}
27-
resources: # how to publish a field in the RG claim e.g. vpcID
27+
resources: # how to publish a field in the RGD claim e.g. vpcID
2828
- id: vpc
2929
template:
3030
apiVersion: ec2.services.k8s.aws/v1alpha1

examples/aws/webstack/Readme.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,17 @@
33
This example creates a ResourceGraphDefinition called `WebStack` comprised of
44
three other RGs: `WebApp`, `S3Bucket`, and `PodIdentity`
55

6-
![Netsted RG Instance](../../images/architecture-diagrams/kro-WebStack.png)
7-
_Fugure 1: Nested RG Example_
6+
![Netsted RGD Instance](../../images/architecture-diagrams/kro-WebStack.png)
7+
_Fugure 1: Nested RGD Example_
88

99
### Create ResourceGraphDefinitions
1010

1111
Change directory to `examples`:
12+
1213
```
1314
cd examples/
1415
```
16+
1517
Apply the RGs to your cluster:
1618

1719
```
@@ -22,7 +24,7 @@ kubectl apply -f webstack/rg.yaml
2224
Validate the RGs statuses are Active:
2325

2426
```
25-
kubectl get rg
27+
kubectl get rgd
2628
```
2729

2830
Expected result:
@@ -36,24 +38,33 @@ webstack.kro.run v1alpha1 WebStack Active 7m
3638
```
3739

3840
### Create an Instance of kind WebStack
41+
3942
Create an environment variable with uniquie name, that will be the name of your S3 Bucket.
43+
4044
```
4145
export RESOURCES_NAME=<test-app-11223344-replace-me-with-random-string>
4246
```
47+
4348
Validate the variable populated:
49+
4450
```
4551
echo $RESOURCES_NAME
4652
```
53+
4754
Expected result:
55+
4856
```
4957
<test-app-11223344-my-random-string>
5058
```
59+
5160
Run the following command to replace the `$RESOURCES_NAME` variable in `instance-tmpl.yaml` file and create
52-
a new file called instance.yaml.
61+
a new file called instance.yaml.
62+
5363
```shell
5464
envsubst < "webstack/instance-tmpl.yaml" > "webstack/instance.yaml"
5565
```
56-
Apply the `webstack/instance.yaml`
66+
67+
Apply the `webstack/instance.yaml`
5768

5869
```
5970
kubectl apply -f webstack/instance.yaml
@@ -96,10 +107,13 @@ Expected result:
96107
```
97108

98109
### Troubleshoot
110+
99111
If you get the folling error:
112+
100113
```
101114
Error connecting to S3:...
102115
```
116+
103117
Try restarting the pod.
104118

105119
### Clean up

examples/kubernetes/webapp/Readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ the default nginx container image.
55

66
### Create ResourceGraphDefinition called WebApp
77

8-
Apply the RG to your cluster:
8+
Apply the RGD to your cluster:
99

1010
```
1111
kubectl apply -f rg.yaml
1212
```
1313

14-
Validate the RG status is Active:
14+
Validate the RGD status is Active:
1515

1616
```
1717
kubectl get rgd webapp.kro.run

test/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,14 @@ controllers, you should:
4848
2. Trigger ResourceGraphDefinition reconciliation
4949
3. Check that the ResourceGraphDefinition status was updated correctly
5050
4. Verify that the correct Create (CRD) call was made to the API server
51-
5. Check that the controller is watching the correct RG instances
51+
5. Check that the controller is watching the correct RGD instances
5252
6. Create a ResourceGraphDefinition instance
5353
7. Trigger the ResourceGraphDefinition instance reconciliation
5454
8. Check that the ResourceGraphDefinition instance status was updated correctly
5555
9. Verify that the some resources were created in the cluster
5656
10. Trigger a second reconciliation and check that the status was updated
5757
correctly
58-
11. Repeat until all the RG instances are created
58+
11. Repeat until all the RGD instances are created
5959
12. Do the same for updates and deletions
6060

6161
## E2e tests

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ metadata:
4444
name: my-application
4545
spec:
4646
# kro uses this simple schema to create your CRD schema and apply it
47-
# The schema defines what users can provide when they instantiate the RG (create an instance).
47+
# The schema defines what users can provide when they instantiate the RGD (create an instance).
4848
schema:
4949
apiVersion: v1alpha1
5050
kind: Application
@@ -140,7 +140,7 @@ spec:
140140
the ResourceGraphDefinition using the `kubectl` command:
141141

142142
```bash
143-
kubectl get rg my-application -owide
143+
kubectl get rgd my-application -owide
144144
```
145145

146146
You should see the ResourceGraphDefinition in the `Active` state, along with relevant

website/docs/docs/overview.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ sidebar_position: 1
44

55
# What is kro?
66

7-
**kro** (Kube Resource Orchestrator) is an open-source, Kubernetes-native project
8-
that allows you to define custom **Kubernetes APIs** using simple and straightforward
9-
configuration. With kro, you can easily configure new custom APIs that create a
10-
group of Kubernetes objects and the logical operations between them. kro leverages
11-
[CEL (Common Expression Language)](https://github.com/google/cel-spec), the same
7+
**kro** (Kube Resource Orchestrator) is an open-source, Kubernetes-native project
8+
that allows you to define custom **Kubernetes APIs** using simple and straightforward
9+
configuration. With kro, you can easily configure new custom APIs that create a
10+
group of Kubernetes objects and the logical operations between them. kro leverages
11+
[CEL (Common Expression Language)](https://github.com/google/cel-spec), the same
1212
language used by Kubernetes webhooks, for logical operations. Using CEL expressions,
1313
you can easily pass values from one object to another and incorporate conditionals into
14-
your custom API definitions. Based on the CEL expressions, kro automatically calculates
15-
the order in which objects should be created. You can define default values for fields
16-
in the API specification, streamlining the process for end users who can then
14+
your custom API definitions. Based on the CEL expressions, kro automatically calculates
15+
the order in which objects should be created. You can define default values for fields
16+
in the API specification, streamlining the process for end users who can then
1717
effortlessly invoke these custom APIs to create grouped resources.
1818

1919
# How does kro work?
@@ -49,7 +49,7 @@ Custom Resources for the ResourceGraphDefinition CRD.
4949
In the depicted example, the **Platform Team** has created a **RG** with
5050
arbitrary name "Application Stack" that encapsulates the necessary resources,
5151
along with any additional logic, abstractions, and security best practices. When
52-
the RG is applied to the cluster, a new API of kind ApplicationStack is created
52+
the RGD is applied to the cluster, a new API of kind ApplicationStack is created
5353
and available for Developer to interact with. The Developers no longer need to
5454
directly manage the underlying infrastructure complexities, as the custom API
5555
handles the deployment and configuration of the required resources.

website/docs/examples/web-app-ingress.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ metadata:
1111
name: my-application
1212
spec:
1313
# kro uses this simple schema to create your CRD schema and apply it
14-
# The schema defines what users can provide when they instantiate the RG (create an instance).
14+
# The schema defines what users can provide when they instantiate the RGD (create an instance).
1515
schema:
1616
apiVersion: v1alpha1
1717
kind: Application

0 commit comments

Comments
 (0)