Skip to content

Commit

Permalink
Chore/public merge (#296)
Browse files Browse the repository at this point in the history
* Update dependency lodash to v4.17.13 [SECURITY] (#1395)

* docs(add-plugin) delete unused page (#1400)

Topic covered in enable-plugin.

* add custom plugin apig-response-transform (#1365)

* Release/0.35-3 (#1406)

* chore(ee/changelog) release 0.34-1 FT-358 (#210)

* docs(ee/changelog) 0.34-1 release

* chore(ee/changelog) remove trailing whitespace

* docs(openid-connect) updated doc to 2.7.0 version

* docs(edits) copy and style edits

* chore(*) merge public repo (#211)

* chore(*) merge public repo

* chore(*) merge public repo (#219)

* feat(docs): 0.35 Release Base

* docs(35): Bump EE Latest Version (#232)

* update travis node version

* docs(35) navigation (#231)

* feat(nav): Adds 3 level navigation (#233)

* docs(35/deployment) copy licensing section (#220)

* Docs/35 nav (#235)

* docs(35) navigation updates

* docs(35): Dev Portal Init

* docs(35/deployment) (#238)

* docs(35/docker) (#222)

* docs(35/centos) (#223)

* docs(35/amazon-linux) (#224)

* fix 35 nav formatting

* docs(nav) remove duplicate sections

* docs(35/km/overview) copy old overview

* docs(35/km/overview) replace start with networking

* docs(35/km/overview) clarify section

* docs(35/km/overview) rbac rewording

* docs(35/km/overview) move workspaces above rbac

* refactor(35/km/overview) fix new lines

* docs(35/km/overview) rbac rewording

* docs(35/km/overview) admins rewording

* docs(35/km/overview) networking button rewording

* docs(35/km/overview) reword workspaces

* fix(35): Add index.md

* fix(35): Update Admin API Nav (#244)

* fix(35): Update Admin API Nav

* feat(docs): 35 Index Page Init (#246)

* Docs/35 dev portal config (#247)

* docs(dev-portal): Auth types

* Docs/35 dev portal config (#248)

* add warning to basic auth

* add workspaces

* docs(35): Audit Log (#249)

* docs(35): Vitals (#239)

* docs(35): Dev Portal Networking Ref (#243)

* docs(35): Property Reference  (#251)

* docs(35/manager) Kong Manager TD-121 (#245)

For RC only

* docs(35)/dev-portal (#236)

* Docs/35 temp plugins (#252)

* Revert "docs(35)/dev-portal (#236)" (#253)

This reverts commit 0d9c2af.

* Docs/35 dev portal temp (#255)

* Docs/getting started temp (#257)

* docs(35/prop-ref) correct name of prop

* docs(35) Admin API (#258)

* docs(35) administration (#259)

* docs(35) remove ad from nav

* docs(35) update admin

* docs(35) reposition nav (#260)

* docs(35) navigation improvements and fixes (#261)

* docs(35) refine getting started (#262)

* docs(35/admin) update reference docs (#263)

* alter nav for rc (#264)

* docs(35/km/auth/oidc) close bracket

Thank you, @Jlawlzz .

* docs(35/admin-api) add examples and corrections (#265)

* fix(35) add items to navigation (#266)

* fix(35/nav) remove typo in nav

* docs(35/admin/example) MVP walkthrough (#267)

* docs(35) start securing km section

* docs(35/getting-started) feedback corrections

* docs(35/admins/ref) add missing attributes (#269)

* docs(35/*) provide security documentation (#270)

* docs(35/km/oidc) improve OIDC (#271)

* docs(35/start) add a note that only one super admin may be seeded

* docs(35) add warning about samesite (#273)

* docs(35/admins/ref) add generate_register_url description INTF-1506 (#272)

Review in staging.

* docs(35/plugin/session) add session doc (#275)

* fix(35/plugin/session) fix template type

* docs(35/getting-started) improve getting started intro (#274)

* docs(ldap-auth-advanced) change property name from ssl to ldaps (#268)

* docs(35/admin-api) update workspaces and rbac responses (#276)

* docs(35/rbac/api) update endpoint permission responses

* docs(35/rbac) permissions endpoints update

* docs(index): Update index grid (#278)

* docs(index): Update index grid

* docs(docker): Update installation commands (#277)

* docs(docker): Update installation commands

* docs(35): Add plugin redirects (#250)

* docs(35): Add plugin redirects

* Docs/35 plugins (#280)

* add redirects for jwt and rbh

* init dev portal files

* docs(35/*) session config and disclaimer (#283)

* Adds details to session configuration
* All places that suggest setting `enforce_rbac = on` now mention `admin_gui_session_conf`
* Adds a disclaimer to any example pertaining to `secret`, `cookie_secure`, and `cookie_samesite`
* All entry points (i.e. places that suggest setting `admin_gui_session_conf`) link to Kong Manager Session doc, which in turn links to Session Plugin after distinguishing the 2
* Clear statement that Session Plugin is required with any auth type
* General stylistic cleanup around the Session page titles

* docs(getting-started): Add grid overview (#282)

* hotfix(35/session) fix yml format

* add managing developers

* update nav for internal preview

* docs(vault-auth) add 0.1-x vault-auth docs (#216)

* docs(vault-auth) add 0.1-x vault-auth docs

* add dev portal docs

* add overview to getting started

* docs(35/km/ws) add note about admins without roles having "access" - EBB 90 (#281)

* docs(35/nav) remove install overview

* docs(35/nav) move down overview to distinct section

* docs(35/nav) flatten nav for upgrades

* docs(35/*) add migration guide

* docs(35/nav) remove aws guide link until update is ready

* hotfix(35/migrations) fix link

* hotfix(35/migrations) fix links

* docs(35/migrations) style the 'important' block

* docs(35/migrations) make external links open new windows

* docs(35/amazon-linux) fix migrations option

* docs(35/docker) fix migrations option

* docs(35/install) hide unused guides

* docs(35/*) fix config link

* fix(35/start) fix link

* fix(35/start) fix link

* fix(35/*) getting started links

* docs(35/*) add security sec

* dev portal updates

* Chore/public merge (#286)

- merge public repo

* fix merge conflicts

* merge public repo

* Release/0.35 3 (#294)

* docs(rate-limiting-advanced) add configuration parameter for redis cluster

* write(35/km) how to reset password and rbac token (#287)

* write(35/km) how to reset password and rbac token

* change hard links to header links

* fix bold formatted words

* fix list numbering

* change hard links to dynamic

* add page to navigation

* Update app/enterprise/0.35-x/kong-manager/reset-password.md

* Update app/enterprise/0.35-x/kong-manager/reset-password.md

Co-Authored-By: levi <[email protected]>

* Update app/enterprise/0.35-x/kong-manager/reset-password.md

* docs(enterprise/migrations) migrate-apis CLI guide (#289)

* chore(properties) add description fro db_cache_warmup_entities configuration (#290)

* chore(changelog) add 0.35-1 and 0.35-3 to changelog for this release (#291)

* chore(changelog) add 0.35-1 and 0.35-3 to changelog for this release

* apply suggestions from code review

* Add cli.md to enterprise doc tree (#292)

* chore(cli) duplicate core cli doc and add new enterprise migrations commands

* chore(nav) update nav to pick up new cli file

* copy updates

* changelog formatting

Adds references to API migration guide to 0.35 migration guide

* remove extra line

* Add Upstream TLS to Hub (#295)

* Add Upstream TLS to Hub

* Add to nav

* Clearer explanation for known issue

* Delete adding-your-api.md

* Delete adding-your-api.md

* Delete best-practices.md

* Delete index.md

* Delete disabling-auth.md

* Delete aws-cloudfront.md

* Delete index.md

* Delete admins.md

* Delete quickstart.md

* Delete google-cloud.md

* Delete route-by-headers.md

* Delete understanding-page-routing.md

* Update macos.md

* Update autodoc-admin-api/run.lua

* Update autodoc-admin-api/run.lua

* Delete package-lock.json

* fix package-lock

* package-lock

* docs(cli-ref) fix link to conf ref (#1412)

Updates link to Enterprise-version; currently 404s.

* fix cli link typo

* Docs/35 install ubuntu (#1396)

* init ubuntu 35 doc

* doc(installation): Add 0.35 Ubuntu doc

* Update app/enterprise/0.35-x/deployment/installation/ubuntu.md

* Update acl/index.md (#1411)

declarative config for acls expects array

* fix egregious broken links while at it

* package log merge conflicts
  • Loading branch information
levfishbluefish authored Jul 25, 2019
1 parent 3a35aec commit 11e24e1
Show file tree
Hide file tree
Showing 10 changed files with 426 additions and 1,160 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions app/_data/docs_nav_ee_0.35-x.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
items:
- text: Docker
url: /deployment/installation/docker
- text: Ubuntu
url: /deployment/installation/ubuntu
- text: CentOS
url: /deployment/installation/centos
- text: Amazon Linux
Expand Down
60 changes: 60 additions & 0 deletions app/_hub/inspur/apig-response-transform/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
name: Inspur Response Transform
publisher: Inspur
categories:
- transformations
type: plugin
desc: kong plugin to transform http response from json to xml
description: |
This plugin transform the response sent by the upstream server on the fly on Kong from json to xml,before returning the response to the client.Because of Nginx's internals, the `Content-Length` header will not be set when transforming a response body.
support_url: https://github.com/kakascx/apig-response-transform/issues
source_url: https://github.com/kakascx/apig-response-transform
license_type: Apache-2.0
license_url: https://github.com/kakascx/apig-response-transform/blob/master/LICENSE

kong_version_compatibility:
community_edition:
compatible:
- 1.2.x
- 1.1.x
incompatible:
- 1.0.x
- 0.14.x
- 0.13.x
- 0.12.x
- 0.11.x
- 0.10.x
- 0.9.x
- 0.8.x
- 0.7.x
- 0.6.x
- 0.5.x
- 0.4.x
- 0.3.x
- 0.2.x

params:
name: apig-response-transform
api_id: False
service_id: True
consumer_id: False
route_id: True
protocols: ["http","https"]
dbless_compatible: True
dbless_explanation: It is recommended to use in dbless mode.
config:
- name: format
required: true
default: xml
value_in_examples: xml
description: |
Describe the format of the response format.
---
### Installation
Recommended:

```bash
$ git clone https://github.com/kakascx/apig-response-transform /opt/kong/plugins
$ cd /opt/kong/plugins/apig-response-transform
$ luarocks make
```
2 changes: 1 addition & 1 deletion app/_hub/kong-inc/acl/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ You can create ACL objects via the `acls:` entry in the declarative configuratio

``` yaml
acls:
consumer: { consumer }
- consumer: { consumer }
group: group1
```
Expand Down
2 changes: 1 addition & 1 deletion app/enterprise/0.35-x/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,4 +311,4 @@ Options:
---


[configuration-reference]: /{{page.kong_version}}/configuration
[configuration-reference]: /enterprise/{{page.kong_version}}/property-reference/
197 changes: 197 additions & 0 deletions app/enterprise/0.35-x/deployment/installation/ubuntu.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,197 @@
---
title: How to Install Kong Enterprise on Ubuntu
---

## Introduction

This guide walks through downloading, installing, and starting Kong Enterprise
using Ubuntu and PostgreSQL 9.5. The configuration shown in this guide is
intended only as an example -- you will want to modify and take additional
measures to secure your Kong Enterprise system before moving to a production
environment.


## Prerequisites

To complete this guide you will need:

- An Ubuntu system with root equivalent access.
- The ability to SSH to the system.


## Step 1. Download Kong Enterprise

1. Download the .deb package

Log in to [Bintray](http://bintray.com) to download the latest Kong
Enterprise .deb for the desired version of Ubuntu. Your **Sales** or
**Support** contact will email this credential to you.

Copy the file to your home directory:

```
$ scp kong-enterprise-edition-0.35.xxx.xxx.deb <ubuntu user>@<serverip:~
```
2. Obtain your Kong Enterprise license
If you do not already have your license file, you can download it from your
account files in Bintray
`https://bintray.com/kong/<YOUR_REPO_NAME>/license#files`
Ensure your license file is in proper `JSON`:
```json
{"license":{"signature":"91e6dd9716d12ffsn4a5ckkb16a556dbebdbc4d0a66d9b2c53f8c8d717eb93dd2bdbe2cb3ef51c20806f14345128907da35","payload":{"customer":"Kong Inc","license_creation_date":"2019-05-07","product_subscription":"Kong Enterprise Edition","admin_seats":"5","support_plan":"None","license_expiration_date":"2021-04-01","license_key":"00Q1K00000zuUAwUAM_a1V1K000005kRhuUAE"},"version":1}}
```

3. Securely copy the license file to the Ubuntu system

```
$ scp license.json <ubuntu username>@<serverip>:~
```
## Step 2. Install Kong Enterprise
1. Install Kong Enterprise
```
$ sudo apt-get update
$ sudo apt-get install openssl libpcre3 procps perl
$ sudo dpkg -i kong-enterprise-edition-0.35.xxx.xxx.deb
```
>Note: Your version may be different based on when you obtained the package
2. Copy the license file to the `/etc/kong` directory
```
$ sudo cp license.json /etc/kong/license.json
```
Kong will look for a valid license in this location.
## Step 3. Install PostgreSQL
1. Install PostgreSQL
```
$ sudo apt-get install postgresql-9.5 postgresql-contrib
```
## Step 4. Create a Kong database and user
1. Switch to PostgreSQL user
```
$ sudo -i -u postgres
```
2. Launch PostgreSQL
```
$ psql
```
3. Run the following command to:
-- Create a Kong user and database
-- Make Kong the owner of the database
-- Set the password of the Kong user to 'kong'
```
$ CREATE USER kong; CREATE DATABASE kong OWNER kong; ALTER USER kong WITH password 'kong';
```
>⚠️**Note**: Make sure the username and password for the Kong Database are
>kept safe. We have used a simple example for illustration purposes only.
4. Exit from PostgreSQL
```
$ \q
```
5. Return to terminal
```
$ exit
```
## Step 5. Modify Kong's configuration file
To use the newly provisioned PostgreSQL database, Kong's configuration file
must be modified to accept the correct PostgreSQL user and password.
1. Make a copy of the default configuration file
```
$ sudo cp /etc/kong/kong.conf.default /etc/kong/kong.conf
```
2. Uncomment and update the PostgreSQL database properties inside the Kong conf:
```
$ sudo vi /etc/kong/kong.conf
```
```
pg_user = kong
pg_password = kong
pg_database = kong
```
## Step 6. Seed the Super Admin _(optional)_
For the added security of Role-Based Access Control (RBAC), it is best to seed
the **Super Admin** before initial start-up.
Create an environment variable with the desired **Super Admin** password:
$ export KONG_PASSWORD=<password-only-you-know>
This will be used during migrations to seed the initial **Super Admin**
password within Kong.
## Step 7. Start Kong
1. Run migrations to prepare the Kong database
```
$ kong migrations bootstrap -c /etc/kong/kong.conf
```
2. Start Kong
```
$ sudo /usr/local/bin/kong start -c /etc/kong/kong.conf
```
3. Verify Kong is working
```
curl -i -X GET --url http://localhost:8001/services
```
You should receive an HTTP/1.1 200 OK message.
## Troubleshooting
If you did not receive an HTTP/1.1 200 OK message, or need assistance completing
setup reach out to your **Support contact** or head over to the
[Support Portal](https://support.konghq.com/support/s/).
## Next Steps
Work through Kong Enterprise's series of
[Getting Started](/enterprise/latest/getting-started) guides to get the most
out of Kong Enterprise.
43 changes: 0 additions & 43 deletions app/enterprise/0.35-x/getting-started/add-plugin.md

This file was deleted.

6 changes: 3 additions & 3 deletions app/enterprise/0.35-x/kong-manager/reset-password.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Prerequisites:

* `enforce_rbac = on`
* `admin_gui_auth = basic-auth`
* [`admin_gui_session_conf` is configured](/enterprise/{{kong.page_version}}/kong-manager/authentication/sessions/).
* [`admin_gui_session_conf` is configured](/enterprise/{{page.kong_version}}/kong-manager/authentication/sessions/).
* Already logged in to Kong Manager

Steps:
Expand All @@ -56,8 +56,8 @@ Steps:
Prerequisites:

* `enforce_rbac = on`
* [`admin_gui_auth` is set](/enterprise/{{kong.page_version}}kong-manager/security/#authentication-with-plugins).
* [`admin_gui_session_conf` is configured](/enterprise/{{kong.page_version}}/kong-manager/authentication/sessions/).
* [`admin_gui_auth` is set](/enterprise/{{page.kong_version}}/kong-manager/security/#authentication-with-plugins).
* [`admin_gui_session_conf` is configured](/enterprise/{{page.kong_version}}/kong-manager/authentication/sessions/).
* Already logged in to Kong Manager

Steps:
Expand Down
Loading

0 comments on commit 11e24e1

Please sign in to comment.