Skip to content

Commit 1b5b854

Browse files
committed
updating docs
1 parent 22a0e5a commit 1b5b854

File tree

2 files changed

+33
-15
lines changed

2 files changed

+33
-15
lines changed

website/docs/docs/getting-started/01-Installation.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,23 @@ note that the software is still under active development and APIs may change.
2727

2828
Once authenticated, install kro using the Helm chart:
2929

30+
Fetch the latest release version from GitHub
3031
```sh
31-
# Fetch the latest release version from GitHub
3232
export KRO_VERSION=$(curl -s \
3333
https://api.github.com/repos/awslabs/kro/releases/latest | \
3434
grep '"tag_name":' | \
3535
sed -E 's/.*"([^"]+)".*/\1/' \
3636
)
37-
38-
# Install kro using Helm
37+
```
38+
Validate `KRO_VERSION` populated with a version
39+
```
40+
echo $KRO_VERSION
41+
```
42+
Install kro using Helm
43+
```
3944
helm install kro oci://public.ecr.aws/kro/kro \
4045
--namespace kro \
46+
--set nameOverride=kro
4147
--create-namespace \
4248
--version=${KRO_VERSION}
4349
```
@@ -50,16 +56,25 @@ correctly:
5056
1. Check the Helm release:
5157

5258
```sh
53-
helm list
59+
helm -n kro list
5460
```
5561

56-
You should see the "kro" release listed.
62+
Expected result: You should see the "kro" release listed.
63+
```
64+
NAME NAMESPACE REVISION STATUS
65+
kro kro 1 deployed
66+
67+
```
5768

5869
2. Check the kro pods:
5970
```sh
6071
kubectl get pods -n kro
6172
```
62-
You should see kro-related pods running.
73+
Expected result: You should see kro-related pods running.
74+
```
75+
NAME READY STATUS RESTARTS AGE
76+
kro-7d98bc6f46-jvjl5 1/1 Running 0 1s
77+
```
6378

6479
## Upgrading kro
6580

website/docs/docs/overview.md

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

55
# What is kro?
66

7-
**kro** (Kube Resource Orchestrator) is an open-source project that allows you
8-
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
11-
automatically calculates the order in which objects should be created. You can
12-
pass values from one object to another, set default values for fields in the API
13-
specification, and incorporate conditionals into your custom API definitions.
14-
End users can easily call these custom APIs to create grouped resources.
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
12+
language used by Kubernetes webhooks, for logical operations. Using CEL expressions,
13+
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
17+
effortlessly invoke these custom APIs to create grouped resources.
1518

1619
# How does kro work?
1720

@@ -110,4 +113,4 @@ involved, check out our
110113
For bugs or feature requests, feel free to
111114
[submit an issue](https://github.com/awslabs/kro/issues). You’re also invited to
112115
join our
113-
[community meeting](https://github.com/awslabs/kro?tab=readme-ov-file#kro).
116+
[community](https://github.com/awslabs/kro?tab=readme-ov-file#community-participation).

0 commit comments

Comments
 (0)