kong / kong-manager Goto Github PK

View Code? Open in Web Editor NEW

241.0 7.0 32.0 5.79 MB

Admin GUI for Kong Gateway (Official)

License: Apache License 2.0

JavaScript 1.65% HTML 0.11% Vue 27.50% TypeScript 67.00% Shell 0.33% SCSS 3.06% CSS 0.34%

kong kong-gateway kong-dashboard kong-admin-gui

kong-manager's Introduction

Kong Manager OSS

Installation | Provide feedback | Ask a question | Contributing | Blog

Kong Manager OSS, a free and open-source UI for Kong, the world's most used open source API Gateway.

Built and maintained with ❤️ by the team at Kong.

Features

Kong Manager OSS allows you to view and edit all Kong Gateway objects using the admin API. It interacts directly with the Kong admin API and does not require a separate database.

Important: Kong Manager OSS is only compatible in Kong Gateway 3.4+

Kong Manager OSS is bundled with Kong Gateway, see Getting Started for information on how to use it. To run Kong Manager OSS locally, please see the contributing section.

Getting Started

To use Kong Manager OSS you'll need a running Kong Gateway instance. This can be a local instance or running on a remote server.

Local testing

The quickest way to get started is using the quickstart script:

curl -Ls https://get.konghq.com/quickstart | bash -s -- -i kong -t latest

Finally, visit https://localhost:8002 to view Kong Manager.

Server usage

Kong Manager OSS is intended to be a local testing tool. However, you can also use it on a public server.

If running Kong Manger OSS on a public server, ensure that ports 8001 and 8002 are only accessible to your IP address

To access Kong Manager OSS from a remote machine, ensure that admin_listen and admin_gui_listen are binding to 0.0.0.0 rather than 127.0.0.1 in kong.conf and restart your Kong Gateway instance.

Why do I need this?

You've been using the admin API just fine for years. Why would you want to use a UI?

Kong Manager OSS is a great way to see your Kong Gateway configuration at glance. You can see the routes and plugins configured on a service and drill in to the configuration of each in a single click.

In addition, the plugin configuration UI provides instructions for each configuration option. You can configure a plugin using the UI with helpful tooltips before running deck dump to see the final configuration values.

Contributing

Kong Manager OSS is written in JavaScript. It uses Vue for it's UI components, and yarn for managing dependencies. To build Kong Manager OSS locally please ensure that you have node.js 18+ and yarn installed.

You'll also need a running Kong Gateway instance. See local testing for a one-line solution. Alternatively, you can build Kong Gateway from source.

Once Kong Gateway is running, run the following command to start the development server:

yarn && yarn serve

Kong Manager OSS is now available at http://localhost:8080

kong-manager's People

Contributors

Stargazers

Watchers

kong-manager's Issues

Updates to database that should be handled by application logic

Is there an existing issue for this?

I have searched the existing issues

Kong version (`$ kong version`)

3.6

Current Behavior

Currently, when a user tries to delete a gateway service, a delete is passed from the application to the database even though a route object still exists that references the gateway service. This results in a foreign key violation. This logic should be handled at the application layer instead of relying on a referential integrity constraint at the database layer. This can be seen from the PostgreSQL server log if standard log levels are used.

postgresql.log

2024-05-03 15:55:57.714 EDT [2174177] ERROR:  update or delete on table "services" violates foreign key constraint "routes_service_id_fkey" on table "routes"
2024-05-03 15:55:57.714 EDT [2174177] DETAIL:  Key (id, ws_id)=(6860e4ea-dfc3-4fd7-957a-95e74006c14d, ed690604-acd9-4032-ad4b-926d11cbea17) is still referenced from table "routes".
2024-05-03 15:55:57.714 EDT [2174177] STATEMENT:  DELETE
          FROM "services"
         WHERE ("id") = ('6860e4ea-dfc3-4fd7-957a-95e74006c14d')
           AND ("ws_id" = 'ed690604-acd9-4032-ad4b-926d11cbea17')

Expected Behavior

Kong should check if any routes are configured for a service before issuing an SQL delete from the services table.

Steps To Reproduce

Configure a gateway service with at least one route. Try to delete the service from the Kong manager UI.

Anything else?

No response

kconfig.js file not exist, but run need it

packages Not Found

Is there an existing issue for this?

I have searched the existing issues

Kong version (`$ kong version`)

latest

Current Behavior

No response

Expected Behavior

No response

Steps To Reproduce

error An unexpected error occurred: "https://registry.yarnpkg.com/@kong-ui/entities-shared/-/entities-shared-0.44.2.tgz: Request failed "404 Not Found"".

node : v18.16.1
yarn: 1.22.19

Anything else?

No response

Custom plugin not showing on Add plugin screen

Is there an existing issue for this?

I have searched the existing issues

Kong version (`$ kong version`)

3.6.1

Current Behavior

Custom plugins do not appears in the list of the plugin that can be added via "New Plugin" button.

Still, custom plugins are listed in the API ("/") response that returns the list of plugins enabled in cluster [plugins.enabled_in_cluster]

Also existing custom plugins are correctly listed in the "Plugins" view and each entry is editable.

Expected Behavior

Custom plugins should appear in the list of plugins (at the end in a separate category) that can be added via "New Plugin" button.

Steps To Reproduce

Open the Plugins view, click on New Plugin.

Anything else?

No response

unable to see Custom Plugins on Plugins page

Is there an existing issue for this?

I have searched the existing issues

Kong version (`$ kong version`)

kong 3.6

Current Behavior

Earlier version, kong 3.5 was showing Custom Built plugins on Kong Manager UI Plugins page. But newly shipped kong manager with kong 3.6 seems to have some kind of bug, unable to see any custom built plugin on UI.

Expected Behavior

No response

Steps To Reproduce

Build any custom plugin with kong 3.6 as base container image.
Check kong manager plugins page, it should show the custom plugin on the page, but doesn't.

Anything else?

No response

kong / kong-manager Goto Github PK

kong-manager's Introduction

Kong Manager OSS

Features

Getting Started

Local testing

Server usage

Why do I need this?

Contributing

kong-manager's People

Contributors

Stargazers

Watchers

Forkers

kong-manager's Issues

Is there an existing issue for this?

Kong version ($ kong version)

Current Behavior

Expected Behavior

Steps To Reproduce

Anything else?

Is there an existing issue for this?

Kong version ($ kong version)

Current Behavior

Expected Behavior

Steps To Reproduce

Anything else?

Is there an existing issue for this?

Kong version ($ kong version)

Current Behavior

Expected Behavior

Steps To Reproduce

Anything else?

Is there an existing issue for this?

Kong version ($ kong version)

Current Behavior

Expected Behavior

Steps To Reproduce

Anything else?

Recommend Projects

Recommend Topics

Recommend Org

Kong version (`$ kong version`)

Kong version (`$ kong version`)

Kong version (`$ kong version`)

Kong version (`$ kong version`)