G8 documentation
Install G8, publish your APIs through it and run it, in your own infrastructure.
Six sessions take you from an empty machine to the first API your clients call with a key. Then the guides do one job per page, the Operate pages cover every area of the console and the server, and the reference lists every setting of every plugin and kind, generated from the product itself.
Start with What G8 isGetting started
Read in order. If G8 is already installed and you were given a role, start at Your first API.
1InstallWhat G8 is, how an installation is laid out, and how G8 itself is installed.
What G8 isThe console, the server, the environments and the gateway, and who does what in them.Plan the installationThe two halves of an installation, which guide to follow for your platform, and what G8 needs from the cluster.Install G8 itselfWhat the G8 server needs before it starts, and what it prints once it does.
2Set upThe first sign-in, the first environment, and the people who may use them.
3PublishThe first API through the gateway, then the guides that protect it, control its traffic, shape it and serve it over HTTPS.
Your first APIPublish a backend, ask every client for a key and set a limit, in about twenty minutes.Protect an APIDecide who may call a route: keys, tokens, passwords, named clients, teams, networks, browsers and your identity provider.Control trafficLimits per route, per client and per group, plugins on every request, a share to a new version, a breaker and a cache.Shape requests and answersChange what the backend sees and what the client gets: the path, the headers and the client address.Serve HTTPSServe HTTPS under your own host name and send HTTP clients to it.
4OperateWhat the gateway did, who changed what, what sits under the console, and the server day to day.
See what happensConnect the environment's log store and Prometheus in Environment settings, then read what the gateway did and be told when something is wrong.Audit and governanceWhat people did: every change from the save to the gateway and into the audit log, and roles shaped to your teams.Under the hoodBeneath the forms: the path of a request, the Raw JSON of an object, copying between environments, and the API a script calls.Run the serverThe G8 server day to day, for whoever runs it: the install, every setting, the backup, the sealing key, the upgrade and what to watch.
Common tasks
Require an API keyPut key-auth on a route and give the first client its key.Give a client its key, and replace itCreate a key, hand it over, and replace it later without a gap.Accept signed tokensPut jwt-auth on a route and give the client the credential that checks the tokens it signs.Let a browser app call the APIPut cors on a route so a web app served from another origin can call the API from the browser, cookies included.Limit requests on a routeAllow each client address a number of requests a minute.Put a language model behind the gatewaySend your apps' chat requests to one language model through a route, with the model's key on the gateway, a token budget, a prompt guard and a cache.Serve HTTPS with your certificateAdd a certificate so clients call the gateway over HTTPS under your host name.See each client's own addressRead the client address from the header your load balancer writes.Users, roles and accessThe built-in roles, what each may do, and how a person gets one.
Sections
GuidesOne job per page: expose an API, protect it, control its traffic, shape requests and answers, serve HTTPS, record traffic, put a language model behind the gateway.ConceptsHow a request travels, where a plugin runs and which copy wins, how a client is told apart.OperateEnvironments, people and roles, the audit log, request records, Analytics and Alerts.ReferenceEvery resource kind and every plugin, with its settings as the console shows them.
By role
Platform administratorInstallAdd an environmentUsers, roles and access
API ownerYour first APIGuidesReference