Skip to content

Commit 3479966

Browse files
authored
Fix(KO): Install docs feedback (#3809)
* remove gateway API install * test * add deployment topology * Update operator-get-started-hybrid-install.md * Update operator.md * Update operator.md * Update operator-get-started-hybrid-install.md * test fix for duplicated block
1 parent f8bdaa0 commit 3479966

File tree

3 files changed

+55
-20
lines changed

3 files changed

+55
-20
lines changed

app/_how-tos/operator-get-started-hybrid-install.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,6 @@ works_on:
2525
min_version:
2626
operator: '1.6.1'
2727

28-
29-
entities: []
30-
3128
tldr:
3229
q: How do I install {{ site.operator_product_name }} in {{ site.konnect_short_name }} hybrid mode?
3330
a: Update the Helm repository and use Helm to install {{ site.operator_product_name }} in {{ site.konnect_short_name }}.

app/_how-tos/operator-get-started-kic-install.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,6 @@ tags:
3636
- install
3737
- helm
3838
---
39-
{% assign gwapi_version = "1.3.0" %}
40-
41-
## Install CRDs
42-
43-
```shell
44-
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v{{ gwapi_version }}/standard-install.yaml
45-
```
4639

4740
{% include k8s/kong-namespace.md %}
4841

app/_includes/prereqs/products/operator.md

Lines changed: 55 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,23 @@
33
{% if prereqs.enterprise %}
44
{% assign summary = summary | append:' (with an Enterprise license)' %}
55
{% endif %}
6+
7+
{% capture license %}
8+
```
9+
echo "
10+
apiVersion: configuration.konghq.com/v1alpha1
11+
kind: KongLicense
12+
metadata:
13+
name: kong-license
14+
rawLicenseString: '$(cat ./license.json)'
15+
" | kubectl apply -f -
16+
```
17+
{% endcapture %}
18+
19+
{% capture cert %}
20+
{% include k8s/cert-manager.md %}
21+
{% endcapture %}
22+
623
{% capture details_content %}
724

825
1. Add the Kong Helm charts:
@@ -16,40 +33,68 @@
1633

1734
{% if include.v_maj == 1 %}
1835

36+
{% if page.works_on contains "konnect"%}
37+
1938
```bash
2039
helm upgrade --install kgo kong/gateway-operator -n kong-system \
2140
--create-namespace \
2241
--set env.ENABLE_CONTROLLER_KONNECT=true{% if prereqs.operator.controllers %} \{% for controller in prereqs.operator.controllers %}
2342
--set env.ENABLE_CONTROLLER_{{ controller | upcase }}=true{% unless forloop.last %} \{% endunless %}{% endfor %}{% endif %}
2443
```
44+
{:data-deployment-topology='konnect'}
45+
46+
{% endif %}
47+
48+
{% if page.works_on contains "on-prem"%}
49+
50+
```bash
51+
helm upgrade --install kgo kong/gateway-operator -n kong-system \
52+
--create-namespace{% if prereqs.operator.controllers %} \{% for controller in prereqs.operator.controllers %}
53+
--set env.ENABLE_CONTROLLER_{{ controller | upcase }}=true{% unless forloop.last %} \{% endunless %}{% endfor %}{% endif %}
54+
```
55+
{:data-deployment-topology='on-prem'}
56+
57+
{% endif %}
2558
2659
{% else %}
2760
61+
{% if page.works_on contains "konnect"%}
62+
2863
```bash
2964
helm upgrade --install kong-operator kong/kong-operator -n kong-system \
3065
--create-namespace \
3166
--set image.tag={{ site.data.operator_latest.release }} \
3267
--set env.ENABLE_CONTROLLER_KONNECT=true{% if prereqs.operator.controllers %} \{% for controller in prereqs.operator.controllers %}
3368
--set env.ENABLE_CONTROLLER_{{ controller | upcase }}=true{% unless forloop.last %} \{% endunless %}{% endfor %}{% endif %}
3469
```
70+
{:data-deployment-topology='konnect'}
3571
72+
{% endif %}
73+
74+
{% if page.works_on contains "on-prem"%}
75+
76+
```bash
77+
helm upgrade --install kong-operator kong/kong-operator -n kong-system \
78+
--create-namespace \
79+
--set image.tag={{ site.data.operator_latest.release }}{% if prereqs.operator.controllers %} \{% for controller in prereqs.operator.controllers %}
80+
--set env.ENABLE_CONTROLLER_{{ controller | upcase }}=true{% unless forloop.last %} \{% endunless %}{% endfor %}{% endif %}
81+
```
82+
{:data-deployment-topology='on-prem'}
83+
84+
{% endif %}
3685
{% endif %}
3786
38-
{% include k8s/cert-manager.md %}
87+
{{cert | indent: 3}}
3988
4089
4190
{% if prereqs.enterprise %}
4291
1. Apply a `KongLicense`. This assumes that your license is available in `./license.json`
92+
{{license | indent: 3}}
93+
94+
{% else %}
95+
This tutorial doesn't require a license, but you can add one using `KongLicense`. This assumes that your license is available in `./license.json`.
96+
{{license}}
4397
44-
```
45-
echo "
46-
apiVersion: configuration.konghq.com/v1alpha1
47-
kind: KongLicense
48-
metadata:
49-
name: kong-license
50-
rawLicenseString: '$(cat ./license.json)'
51-
" | kubectl apply -f -
52-
```
5398
{% endif %}
5499
{% endcapture %}
55100

0 commit comments

Comments
 (0)