Skip to content

Commit e888ed9

Browse files
authored
APISIX doc update (#1130)
* APISIX doc update Signed-off-by: Andy Tael <[email protected]> * APISIX update and Docusaurus new version Signed-off-by: Andy Tael <[email protected]> --------- Signed-off-by: Andy Tael <[email protected]>
1 parent 9bc4431 commit e888ed9

File tree

4 files changed

+368
-344
lines changed

4 files changed

+368
-344
lines changed

docs-source/site/docs/platform/apisix.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,36 @@ kubectl port-forward -n obaas-dev svc/apisix-admin 9180
2424

2525
To access the APISIX APIs, you need the admin key. Retrieve it with the following command (replace the example namespace `obaas-dev` with the namespace where APISIX is deployed):
2626

27-
```shell
28-
export admin_key=$(kubectl -n obaas-dev get configmap apisix -o yaml | yq '.data."config.yaml"' | yq '.deployment.admin.admin_key[] | select(.name == "admin") | .key')
27+
**Option 1 - Using yq:**
28+
29+
```bash
30+
kubectl -n obaas-dev get configmap apisix -o yaml | yq '.data."config.yaml"' | yq '.deployment.admin.admin_key[] | select(.name == "admin") | .key'
2931
```
3032

33+
**Option 2 - Manual retrieval:**
34+
35+
If the command above doesn't work:
36+
37+
1. Run: `kubectl get configmap apisix -n obaas-dev -o yaml`
38+
1. Look for the `config.yaml` section
39+
1. Find `deployment.admin.admin_key` and copy the key value
40+
3141
Test the admin key by running a simple curl command; it should return the list of configured routes.
3242

3343
```shell
3444
curl http://127.0.0.1:9180/apisix/admin/routes -H "X-API-key: $admin_key" -X GET
3545
```
46+
47+
### Accessing APISIX Dashboard
48+
49+
:::note
50+
Note that all functionality is not available in the dashboard. You might need to use the REST APIs
51+
:::
52+
53+
APISIX has an embedded dashboard that can be accessed after a tunnel is established to the `apisix-admin` service. The dashboard is available on this [URL](http://localhost:8190/ui). **NOTE:** you need the Admin key to be able to access the dashboard.
54+
55+
![APISIX Dashboard](images/apisix-dashboard.png)
56+
57+
### Configuring APISIX using REST APIs
58+
59+
You can configure and update the APISIX gateway using the provided APIs. [API Documentation](https://apisix.apache.org/docs/apisix/getting-started/README/)
235 KB
Loading

0 commit comments

Comments
 (0)