Skip to content

Commit c5a2988

Browse files
authored
Merge pull request #124 from awslabs/docs
Update installation docs
2 parents d3b18f7 + 893f95e commit c5a2988

File tree

2 files changed

+47
-17
lines changed

2 files changed

+47
-17
lines changed

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

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,16 @@ Before you begin, ensure you have the following:
1313

1414
1. `Helm` 3.x installed
1515
2. `kubectl` installed and configured to interact with your Kubernetes cluster
16+
3. `awscli` installed
17+
18+
Log in to public ecr:
19+
```
20+
aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
21+
```
22+
Expected result:
23+
```
24+
Login Succeeded
25+
```
1626

1727
## Installation Steps
1828

@@ -27,17 +37,23 @@ note that the software is still under active development and APIs may change.
2737

2838
Once authenticated, install kro using the Helm chart:
2939

40+
Fetch the latest release version from GitHub
3041
```sh
31-
# Fetch the latest release version from GitHub
3242
export KRO_VERSION=$(curl -s \
3343
https://api.github.com/repos/awslabs/kro/releases/latest | \
3444
grep '"tag_name":' | \
3545
sed -E 's/.*"([^"]+)".*/\1/' \
3646
)
37-
38-
# Install kro using Helm
47+
```
48+
Validate `KRO_VERSION` populated with a version
49+
```
50+
echo $KRO_VERSION
51+
```
52+
Install kro using Helm
53+
```
3954
helm install kro oci://public.ecr.aws/kro/kro \
4055
--namespace kro \
56+
--set nameOverride=kro
4157
--create-namespace \
4258
--version=${KRO_VERSION}
4359
```
@@ -50,28 +66,39 @@ correctly:
5066
1. Check the Helm release:
5167

5268
```sh
53-
helm list
69+
helm -n kro list
5470
```
5571

56-
You should see the "kro" release listed.
72+
Expected result: You should see the "kro" release listed.
73+
```
74+
NAME NAMESPACE REVISION STATUS
75+
kro kro 1 deployed
76+
```
5777

5878
2. Check the kro pods:
5979
```sh
6080
kubectl get pods -n kro
6181
```
62-
You should see kro-related pods running.
82+
Expected result: You should see kro-related pods running.
83+
```
84+
NAME READY STATUS RESTARTS AGE
85+
kro-7d98bc6f46-jvjl5 1/1 Running 0 1s
86+
```
6387

6488
## Upgrading kro
6589

6690
To upgrade to a newer version of kro, use the Helm upgrade command:
6791

92+
Replace `<new-version>` with the version you want to upgrade to.
6893
```bash
69-
# Replace `<new-version>` with the version you want to upgrade to.
7094
export KRO_VERSION=<new-version>
95+
```
7196

72-
# Upgrade the controller
97+
Upgrade the controller
98+
```
7399
helm upgrade kro oci://public.ecr.aws/kro/kro \
74100
--namespace kro \
101+
--set nameOverride=kro
75102
--version=${KRO_VERSION}
76103
```
77104

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)