Skip to content

Commit e578de6

Browse files
committed
Remove CRDs folder
1 parent 379b136 commit e578de6

File tree

7 files changed

+50
-6252
lines changed

7 files changed

+50
-6252
lines changed

Makefile

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,6 @@ njs-unit-test: ## Run unit tests for the njs httpmatches module
9999
generate-njs-yaml: ## Generate the njs-modules ConfigMap
100100
kubectl create configmap njs-modules --from-file=$(NJS_DIR)/httpmatches.js --dry-run=client --output=yaml > $(strip $(MANIFEST_DIR))/njs-modules.yaml
101101

102-
.PHONY: fetch-crds-yaml
103-
fetch-crds-yaml: ## Fetch the Gateway API resources yaml and output it to the Helm chart crds folder
104-
curl -s -L https://github.com/kubernetes-sigs/gateway-api/releases/download/v$(strip $(GW_API_VERSION))/standard-install.yaml -o $(CHART_DIR)/crds/gateway-crds.yaml
105-
106102
.PHONY: lint-helm
107103
lint-helm: ## Run the helm chart linter
108104
helm lint $(CHART_DIR)

deploy/helm-chart/README.md

Lines changed: 44 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -12,104 +12,96 @@ This chart deploys the NGINX Kubernetes Gateway in your Kubernetes cluster.
1212
> Note: NGINX Kubernetes Gateway can only run in the `nginx-gateway` namespace. This limitation will be addressed in
1313
the future releases.
1414

15-
## Installing the Chart
15+
### Installing the Gateway API resources
1616

1717
> Note: The Gateway API resources from the standard channel (the CRDs and the validating webhook) must be installed
18-
before deploying NGINX Kubernetes Gateway. By default, they will be installed by the Chart if not already
19-
present in the cluster. If they are already installed in your cluster, please ensure they are the correct version as
20-
supported by the NGINX Kubernetes Gateway - [see the Technical Specifications](../../README.md#technical-specifications).
21-
Helm will not upgrade CRDs - to do so manually, see
22-
[Upgrading the Gateway API resources](#upgrading-the-gateway-resources).
18+
before deploying NGINX Kubernetes Gateway. If they are already installed in your cluster, please ensure they are the
19+
correct version as supported by the NGINX Kubernetes Gateway -
20+
[see the Technical Specifications](../../README.md#technical-specifications).
21+
22+
To install the Gateway resources from [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run:
23+
24+
```shell
25+
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.7.1/standard-install.yaml
26+
```
27+
28+
## Installing the Chart
2329

2430
### Installing the Chart from the OCI Registry
2531

2632
To install the chart with the release name `my-release` (`my-release` is the name that you choose) into the
27-
nginx-gateway namespace (with optional `--create-namespace` flag - you can omit if the namespace already exists), and
28-
the Gateway API resources from the standard channel (if not already present):
33+
nginx-gateway namespace (with optional `--create-namespace` flag - you can omit if the namespace already exists):
2934

30-
```
31-
helm install my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --version 0.0.0-edge --create-namespace --wait --wait-for-jobs -n nginx-gateway
35+
```shell
36+
helm install my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --version 0.0.0-edge --create-namespace --wait -n nginx-gateway
3237
```
3338

3439
### Installing the Chart via Sources
3540

3641
#### Pulling the Chart
3742

38-
```
43+
```shell
3944
helm pull oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --untar --version 0.0.0-edge
4045
cd nginx-gateway
4146
```
4247

4348
#### Installing the Chart
4449

4550
To install the chart with the release name `my-release` (`my-release` is the name that you choose) into the
46-
nginx-gateway namespace (with optional `--create-namespace` flag - you can omit if the namespace already exists), and
47-
the Gateway API resources from the standard channel (if not already present):
51+
nginx-gateway namespace (with optional `--create-namespace` flag - you can omit if the namespace already exists):
4852

49-
```
50-
helm install my-release . --create-namespace --wait --wait-for-jobs -n nginx-gateway
53+
```shell
54+
helm install my-release . --create-namespace --wait -n nginx-gateway
5155
```
5256

5357
## Upgrading the Chart
5458
### Upgrading the Gateway Resources
55-
Helm does not upgrade CRDs during a release upgrade, or on an install if they are already present in the cluster.
56-
Before you upgrade a release, ensure the Gateway API resources are up to date by doing one of the following:
57-
58-
1. To upgrade the Gateway resources from [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run:
59-
```
60-
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.7.1/standard-install.yaml
61-
```
62-
1. To upgrade the Gateway resources from the NGINX Kubernetes Gateway Chart sources, pull the chart sources as described
63-
in [Pulling the Chart](#pulling-the-chart) and then run:
64-
```
65-
kubectl apply -f crds/
66-
```
67-
68-
>Note: The following warning is expected and can be ignored: `Warning: kubectl apply should be used on resource created
69-
by either kubectl create --save-config or kubectl apply`.
59+
Before you upgrade a release, ensure the Gateway API resources are the correct version as supported by the NGINX
60+
Kubernetes Gateway - [see the Technical Specifications](../../README.md#technical-specifications).:
61+
62+
To upgrade the Gateway resources from [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run:
63+
64+
```shell
65+
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.7.1/standard-install.yaml
66+
```
7067

7168
### Upgrading the Chart from the OCI Registry
7269
To upgrade the release `my-release`, run:
7370

74-
```
71+
```shell
7572
helm upgrade my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --version 0.0.0-edge -n nginx-gateway
7673
```
7774

7875
### Upgrading the Chart from the Sources
7976

8077
Pull the chart sources as described in [Pulling the Chart](#pulling-the-chart), if not already present. Then, to upgrade
8178
the release `my-release`, run:
82-
```
79+
80+
```shell
8381
helm upgrade my-release . -n nginx-gateway
8482
```
8583

8684
## Uninstalling the Chart
8785

8886
To uninstall/delete the release `my-release`:
8987

90-
```
88+
```shell
9189
helm uninstall my-release -n nginx-gateway
9290
```
9391

9492
The command removes all the Kubernetes components associated with the release and deletes the release.
9593

9694
### Uninstalling the Gateway Resources
97-
Uninstalling the release does NOT uninstall the CRDs or validating webhook. To clean up these resources, do one of the
98-
following:
9995

100-
>**Warning: These commands will delete all the corresponding custom resources in your cluster across all namespaces!
96+
>**Warning: This command will delete all the corresponding custom resources in your cluster across all namespaces!
10197
Please ensure there are no custom resources that you want to keep and there are no other Gateway API implementations
10298
running in the cluster!**
10399

104-
1. To delete the Gateway resources using [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run:
105-
```
106-
kubectl delete -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.7.1/standard-install.yaml
107-
```
108-
1. To delete the Gateway resources using the NGINX Kubernetes Gateway Chart sources, pull the chart sources as described
109-
in [Pulling the Chart](#pulling-the-chart) and then run:
110-
```
111-
kubectl delete -f crds/
112-
```
100+
To delete the Gateway resources using [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run:
101+
102+
```shell
103+
kubectl delete -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.7.1/standard-install.yaml
104+
```
113105

114106
## Configuration
115107

@@ -119,18 +111,18 @@ The following tables lists the configurable parameters of the NGINX Kubernetes G
119111
| --- | --- | --- |
120112
|`nginxGateway.image.repository` | The repository for the NGINX Kubernetes Gateway image. | ghcr.io/nginxinc/nginx-kubernetes-gateway |
121113
|`nginxGateway.image.tag` | The tag for the NGINX Kubernetes Gateway image. | edge |
122-
|`nginxGateway.image.pullPolicy` | The imagePullPolicy for the NGINX Kubernetes Gateway image. | Always |
114+
|`nginxGateway.image.pullPolicy` | The `imagePullPolicy` for the NGINX Kubernetes Gateway image. | Always |
123115
|`nginxGateway.gatewayClassName` | The name of the GatewayClass for the NGINX Kubernetes Gateway deployment. | nginx |
124116
|`nginxGateway.gatewayControllerName` | The name of the Gateway controller. The controller name must be of the form: DOMAIN/PATH. The controller's domain is k8s-gateway.nginx.org. | k8s-gateway.nginx.org/nginx-gateway-controller |
125117
|`nginx.image.repository` | The repository for the NGINX image. | nginx |
126118
|`nginx.image.tag` | The tag for the NGINX image. | 1.25 |
127-
|`nginx.image.pullPolicy` | The imagePullPolicy for the NGINX image. | Always |
128-
|`initContainer.image.repository` | The repository for the initContainer image. | busybox |
129-
|`initContainer.image.tag` | The tag for the initContainer image. | 1.36 |
130-
|`serviceAccount.annotations` | Annotations for the ServiceAccount used by the NGINX Kubernetes Gateway deployment. | {} |
119+
|`nginx.image.pullPolicy` | The `imagePullPolicy` for the NGINX image. | Always |
120+
|`initContainer.image.repository` | The repository for the `initContainer` image. | busybox |
121+
|`initContainer.image.tag` | The tag for the `initContainer` image. | 1.36 |
122+
|`serviceAccount.annotations` | The `annotations` for the ServiceAccount used by the NGINX Kubernetes Gateway deployment. | {} |
131123
|`serviceAccount.name` | Name of the ServiceAccount used by the NGINX Kubernetes Gateway deployment. | Autogenerated |
132124
|`service.create` | Creates a service to expose the NGINX Kubernetes Gateway pods. | true |
133125
|`service.type` | The type of service to create for the NGINX Kubernetes Gateway. | Loadbalancer |
134-
|`service.externalTrafficPolicy` | The externalTrafficPolicy of the service. The value Local preserves the client source IP. | Local |
135-
|`service.annotations` | The annotations of the NGINX Kubernetes Gateway service. | {} |
126+
|`service.externalTrafficPolicy` | The `externalTrafficPolicy` of the service. The value `Local` preserves the client source IP. | Local |
127+
|`service.annotations` | The `annotations` of the NGINX Kubernetes Gateway service. | {} |
136128
|`service.ports` | A list of ports to expose through the NGINX Kubernetes Gateway service. Update it to match the listener ports from your Gateway resource. Follows the conventional Kubernetes yaml syntax for service ports. | [ port: 80, targetPort: 80, protocol: TCP, name: http; port: 443, targetPort: 443, protocol: TCP, name: https ] |

0 commit comments

Comments
 (0)