Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add upgrade guide #735

Merged
merged 4 commits into from
Nov 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions docs/en/latest/upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: Upgrade Guide
---

<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
-->

## Validate Compatibility

Apache APISIX Ingress project is a continuously actively developed project.
In order to make it better, some broken changes will be added when the new version is released.
For users, how to upgrade safely becomes very important.

The policy directory of this project contains these compatibility check strategies,
you can use the [`conftest`](https://github.com/open-policy-agent/conftest) tool to check the compatibility.

Here's a quick example.

```yaml
apiVersion: apisix.apache.org/v2beta2
kind: ApisixRoute
metadata:
name: httpbin-route
spec:
http:
- name: rule1
match:
hosts:
- httpbin.org
paths:
- /ip
exprs:
- subject:
scope: Header
name: X-Foo
op: Equal
value: bar
backend:
serviceName: httpbin
servicePort: 80
```

It uses the `spec.http.backend` field that has been removed.
Save as httpbin-route.yaml.

Use conftest for compatibility check.

```bash
$ conftest test httpbin-route.yaml
FAIL - httpbin-route.yaml - main - ApisixRoute/httpbin-route: rule1 field http.backend has been removed, use http.backends instead.

2 tests, 1 passed, 0 warnings, 1 failure, 0 exceptions
```

Incompatible parts will generate errors.
49 changes: 49 additions & 0 deletions policy/base.rego
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
package main

deny[msg] {
input.apiVersion == "v1"
input.kind == "List"
obj := input.items[_]
msg := _deny with input as obj
}

deny[msg] {
input.apiVersion != "v1"
input.kind != "List"
msg := _deny
}

# Base on https://github.com/apache/apisix-ingress-controller/blob/master/CHANGELOG.md#130
# ApisixRoute under apisix.apache.org/v1, apisix.apache.org/v2alpha1
# and apisix.apache.org/v2beta1 - use apisix.apache.org/v2beta2 instead
_deny = msg {
input.kind == "ApisixRoute"
apis := ["apisix.apache.org/v1", "apisix.apache.org/v2alpha1", "apisix.apache.org/v2beta1"]
input.apiVersion == apis[_]
msg := sprintf("%s/%s: API %s has been deprecated, use apisix.apache.org/v2beta2 instead.", [input.kind, input.metadata.name, input.apiVersion])
}

# From apisix.apache.org/v2beta2 the ApisixRoute's spec.http.backend field has been removed
_deny = msg {
input.apiVersion == "apisix.apache.org/v2beta2"
input.kind == "ApisixRoute"
some i
input.spec.http[i].backend
msg := sprintf("%s/%s: %s field http.backend has been removed, use http.backends instead.", [input.kind, input.metadata.name, input.spec.http[i].name])
}