Skip to content

Commit 6ccacc1

Browse files
committed
refactor(examples): Update and expand ResourceGroup examples
- Reorganize examples into Basic and Advanced sections - Add new examples for deploying CoreDNS, controllers, AWS resources - Rename some examples for clarity (e.g. web-app instead of deploymentservice) - Remove outdated EKSCluster example - Add an index page summarizing the available examples docs(concepts): Improve ResourceGroup and schema documentation - Rewrite ResourceGroup concepts to be more clear and approachable - Expand schema documentation to cover markers, status fields, conditions - Clarify Instance lifecycle, status fields, and best practices - Fix typos and formatting issues
1 parent c3cdc36 commit 6ccacc1

21 files changed

+1395
-558
lines changed
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: kro.run/v1alpha1
2-
kind: Redis
2+
kind: Valkey
33
metadata:
44
name: my-cache-subnetgroup
55
spec:
6-
name: my-cache-subnetgroup
6+
name: my-cache-subnetgroup
Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,68 @@
11
apiVersion: kro.run/v1alpha1
22
kind: ResourceGroup
33
metadata:
4-
name: redis.kro.run
4+
name: valkey.kro.run
55
spec:
66
schema:
77
apiVersion: v1alpha1
8-
kind: Redis
8+
kind: Valkey
99
spec:
1010
name: string
1111
status:
1212
csgARN: ${cacheSubnetGroup.status.ackResourceMetadata.arn}
1313
subnets: ${cacheSubnetGroup.status.subnets}
14-
clusterARN: ${redis.status.ackResourceMetadata.arn}
14+
clusterARN: ${valkey.status.ackResourceMetadata.arn}
1515
resources:
16-
- name: networkingStack
17-
template:
18-
apiVersion: kro.run/v1alpha1
19-
kind: NetworkingStack
20-
metadata:
21-
name: ${schema.spec.name}-networking-stack
22-
spec:
23-
name: ${schema.spec.name}-networking-stack
24-
- name: cacheSubnetGroup
25-
template:
26-
apiVersion: elasticache.services.k8s.aws/v1alpha1
27-
kind: CacheSubnetGroup
28-
metadata:
29-
name: ${schema.spec.name}-redis-subnet-group
30-
spec:
31-
cacheSubnetGroupDescription: "Redis ElastiCache subnet group"
32-
cacheSubnetGroupName: ${schema.spec.name}-redis-subnet-group
33-
subnetIDs:
34-
- ${networkingStack.status.networkingInfo.subnetAZA}
35-
- ${networkingStack.status.networkingInfo.subnetAZB}
36-
- ${networkingStack.status.networkingInfo.subnetAZC}
37-
- name: sg
38-
template:
39-
apiVersion: ec2.services.k8s.aws/v1alpha1
40-
kind: SecurityGroup
41-
metadata:
42-
name: ${schema.spec.name}-redis-sg
43-
spec:
44-
name: ${schema.spec.name}-redis-sg
45-
description: "Redis ElastiCache security group"
46-
vpcID: ${networkingStack.status.networkingInfo.vpcID}
47-
ingressRules:
48-
- fromPort: 6379
49-
toPort: 6379
50-
ipProtocol: tcp
51-
ipRanges:
52-
- cidrIP: 0.0.0.0/0
53-
- name: redis
54-
template:
55-
apiVersion: elasticache.services.k8s.aws/v1alpha1
56-
kind: CacheCluster
57-
metadata:
58-
name: ${schema.spec.name}-redis
59-
spec:
60-
cacheClusterID: vote-redis-cluster
61-
cacheNodeType: cache.t3.micro
62-
cacheSubnetGroupName: ${schema.spec.name}-redis-subnet-group
63-
engine: redis
64-
engineVersion: "7.1"
65-
numCacheNodes: 1
66-
port: 6379
67-
securityGroupIDs:
68-
- ${sg.status.id}
16+
- name: networkingStack
17+
template:
18+
apiVersion: kro.run/v1alpha1
19+
kind: NetworkingStack
20+
metadata:
21+
name: ${schema.spec.name}-networking-stack
22+
spec:
23+
name: ${schema.spec.name}-networking-stack
24+
- name: cacheSubnetGroup
25+
template:
26+
apiVersion: elasticache.services.k8s.aws/v1alpha1
27+
kind: CacheSubnetGroup
28+
metadata:
29+
name: ${schema.spec.name}-valkey-subnet-group
30+
spec:
31+
cacheSubnetGroupDescription: "Valkey ElastiCache subnet group"
32+
cacheSubnetGroupName: ${schema.spec.name}-valkey-subnet-group
33+
subnetIDs:
34+
- ${networkingStack.status.networkingInfo.subnetAZA}
35+
- ${networkingStack.status.networkingInfo.subnetAZB}
36+
- ${networkingStack.status.networkingInfo.subnetAZC}
37+
- name: sg
38+
template:
39+
apiVersion: ec2.services.k8s.aws/v1alpha1
40+
kind: SecurityGroup
41+
metadata:
42+
name: ${schema.spec.name}-valkey-sg
43+
spec:
44+
name: ${schema.spec.name}-valkey-sg
45+
description: "Valkey ElastiCache security group"
46+
vpcID: ${networkingStack.status.networkingInfo.vpcID}
47+
ingressRules:
48+
- fromPort: 6379
49+
toPort: 6379
50+
ipProtocol: tcp
51+
ipRanges:
52+
- cidrIP: 0.0.0.0/0
53+
- name: valkey
54+
template:
55+
apiVersion: elasticache.services.k8s.aws/v1alpha1
56+
kind: CacheCluster
57+
metadata:
58+
name: ${schema.spec.name}-valkey
59+
spec:
60+
cacheClusterID: vote-valkey-cluster
61+
cacheNodeType: cache.t3.micro
62+
cacheSubnetGroupName: ${schema.spec.name}-valkey-subnet-group
63+
engine: valkey
64+
engineVersion: "8.x"
65+
numCacheNodes: 1
66+
port: 6379
67+
securityGroupIDs:
68+
- ${sg.status.id}
Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
apiVersion: kro.run/v1alpha1
22
kind: ResourceGroup
33
metadata:
4-
name: redis.kro.run
4+
name: valkey.kro.run
55
spec:
66
schema:
77
apiVersion: v1alpha1
8-
kind: Redis
8+
kind: Valkey
99
spec:
1010
name: string
1111
subnetIDs: "[]string"
1212
status:
1313
csgARN: ${cacheSubnetGroup.status.ackResourceMetadata.arn}
1414
subnets: ${cacheSubnetGroup.status.subnets}
1515
resources:
16-
- name: cacheSubnetGroup
17-
template:
18-
apiVersion: elasticache.services.k8s.aws/v1alpha1
19-
kind: CacheSubnetGroup
20-
metadata:
21-
name: ${schema.spec.name}-redis-subnet-group
22-
spec:
23-
cacheSubnetGroupDescription: "Redis ElastiCache subnet group"
24-
cacheSubnetGroupName: ${schema.spec.name}-redis-subnet-group
25-
subnetIDs: ${schema.spec.subnetIDs}
16+
- name: cacheSubnetGroup
17+
template:
18+
apiVersion: elasticache.services.k8s.aws/v1alpha1
19+
kind: CacheSubnetGroup
20+
metadata:
21+
name: ${schema.spec.name}-valkey-subnet-group
22+
spec:
23+
cacheSubnetGroupDescription: "Valkey ElastiCache subnet group"
24+
cacheSubnetGroupName: ${schema.spec.name}-valkey-subnet-group
25+
subnetIDs: ${schema.spec.subnetIDs}

0 commit comments

Comments
 (0)