Skip to main content

Operate

An Operate page describes one area of the console: what it shows, who may open it, what each control does and what the server does behind it. The sections below put the pages in reading order, from the first environment to the server's day to day; a concept page sits where it explains what the pages after it rely on.

Environments and people​

The console's own objects: the environments, and the people and scripts that may use them.

  1. Environments. What an environment is, what stays separate, and what each connection adds.
  2. Add an environment. Connect G8 to a gateway cluster that is already running.
  3. Environment settings. What an environment's settings hold, how its keys are kept, and what the gateway card on the Overview shows.
  4. Sign in and first setup. The setup token, the first administrator, the sign-in form, a forced password change and the account menu.
  5. Users, roles and access. The built-in roles, what each may do, and how a person gets one.
  6. Connect Active Directory. Sign people in with their domain account, give roles by directory group, and what the server does with the directory behind it.
  7. Custom roles. How a custom role is made from the permission dictionary, what the built-in roles hold, and which values a role sees masked.
  8. Service accounts and the API. Service accounts, their tokens, how a script calls the API with one, and where the API is described.

See what happens​

Connect the environment's log store and Prometheus in Environment settings, then read what the gateway did and be told when something is wrong.

  1. Where request records go. How the gateway writes a record of each request into the environment's log store, how G8 reads it back, and when it is deleted.
  2. Request records. Traffic Explorer: what it shows, what has to be connected, and how long records are kept.
  3. Where the numbers come from. How the gateway counts and times requests, how Prometheus keeps those numbers, and how Analytics reads them.
  4. Analytics. Request counts, who answered, response times and the busiest routes, read from Prometheus.
  5. Alerts. Traffic and system alert rules, and where their notifications go.

Audit and governance​

What people did: every change from the save to the gateway and into the audit log, and roles shaped to your teams.

  1. How the console writes to the gateway. What happens between saving an object in the console and the change on the gateway, and what the audit log records on the way.
  2. Audit log. What the environment and platform audit logs record, what a row shows, and the CSV export.
  3. Custom roles. How a custom role is made from the permission dictionary, what the built-in roles hold, and which values a role sees masked.

Under the hood​

Beneath the forms: the path of a request, the Raw JSON of an object, copying between environments, and the API a script calls.

  1. How G8 handles a request. The way a request takes through the gateway, and the objects you create in the console along it.
  2. Raw JSON and copy to environment. The Raw JSON tab of a gateway object, who may edit it, how a save is checked, and how an object is copied to another environment.
  3. Service accounts and the API. Service accounts, their tokens, how a script calls the API with one, and where the API is described.

Run the server​

The G8 server day to day, for whoever runs it: the install, every setting, the backup, the sealing key, the upgrade and what to watch.

  1. Install G8 on OKD or OpenShift. Install the G8 server and console with its Helm chart on a cluster that already runs a gateway cluster, from the three Secrets to the first sign-in.
  2. Server configuration. Every setting the G8 server reads at start, what it does, and its default.
  3. Back up and restore. What a G8 installation consists of, what has to be saved, and how a saved copy is brought back.
  4. Rotate the secrets key. The three phases that move every sealed secret from the old key to a new one without a moment where two keys serve.
  5. Upgrade G8. What a new G8 release changes at start, the order with a gateway upgrade, the steps on OKD and OpenShift, and the way back.
  6. What to watch. The three addresses the server answers without a session, the log lines worth an alert, and where the numbers about the gateway live instead.
G8 dev