Nebraska doesn't support groups but instead assumes that there is a
single team in the Nebraska database. This means that we need to setup
a separate Nebraska instance for separation between different customers
or projects. Update the docs accordingly.

Also, move the documentation to docs/auth.md

This commit closes #28

Signed-off-by: Ashijeet Acharya <[email protected]>

This patch uses Nebraska's name instead of CoreRoller + rollerd,
simplifies how some things are written, and reflects the use of the
new tools (like the Makefile) to build the project.

It also removes the screenshots from the project tree (they are no
longer reflected in the README).

They have outdated flag names. Also there are simpler steps when using
noop authentication.

If the flag `-gh-enterprise-url` is specified, use that as endpoint for
GitHub authentication following the GitHub Enterprise conventions.

`authentication)` is currently off in a new line below the header.

The documentation about running a database for development was still
using the container built by CoreRoller (and with the name updated to
Nebraska by mistake).

Instead of relying on a dedicated container for the database, we should
just provide the instructions to quickly set it up for Nebraska. So
these changes replace the mentioned legacy instructions this way.

The Dockerfile was still using the old "built" directory instead of
the new "build" directory that is generated by create-react-app's
scripts.

This patch fixes that and updates the documentation as well.

The README was getting very long and we would also like to show the
documentation in the Kinvolk docs portal, so this patch simply moves
some of the docs from the README into their own files.

This is necessary for the docs integration in the new Kinvolk's docs
portal.

Make the docs more consistent with Headlamp's and add a new
development section.

Github has a dark mode where the transparent-background logo will not
look good. So until Github supports theme-context logos in the README,
this is a good enough solution.

The cloud-init cloud config example should not be prominent because
Container Linux Config (Ignition) is the recommended way for
provisioning. Since both are YAML it's confusing to mention the
cloud-init format in the example.

The machine alias is a recent Nebraska feature which wasn't documented
yet.

We want to allow the integration of Nebraska with as many other projects
as possible, and to make its license consistent with the rest of the
Kinvolk's projects, so we're relicensing it as Apache 2.0.

Acked-By:
  Leon Plazier <[email protected]>
  Marco Kilchhofer <[email protected]>
  Ricardo Katz <[email protected]>
  Robin Elfrink <[email protected], [email protected]>
  Tom Offermann <[email protected]>

This patch adds documentation for setting
up Keycloak for OIDC

Signed-off-by: Santhosh Nagaraj S <[email protected]>

This patch adds documentation for setting
up Auth0 as OIDC provider

Signed-off-by: Santhosh Nagaraj S <[email protected]>

This patch adds documentation for deploying
nebraska with OIDC authentication mode.

Signed-off-by: Santhosh Nagaraj S <[email protected]>

this patch removes github auth mode documentation
as it is not supported

Signed-off-by: Santhosh Nagaraj S <[email protected]>

This patch adds documentation for setting up
Dex with Github connection as OIDC provider.

Signed-off-by: Santhosh Nagaraj S <[email protected]>

Based on the headlamp i18n methods.

This patch adds a Note to setup the oidc-roles-path
argument.

Signed-off-by: Santhosh Nagaraj S <[email protected]>

So that you can run the dev server, and have a test db at the
same time as running `make check-backend-with-container`.

NEBRASKA_TEST_SERVER_URL can be used to tell tests where to find
the test server.

Integration test improvements

Nowadays Nebraska supports group aliases and the UUID is not needed
anymore. While the whitespace in the machine alias works for
update_engine there are some other parts in Flatcar that try to source
the update.conf file and fail when it has unqouted whitespace. Also,
the restart of update-engine.service is not really needed and it's
probably good to point the user to the Flatcar docs for more info.

this patch adds documentation for migrating to
a older version of Nebraska.

Signed-off-by: Santhosh Nagaraj S <[email protected]>

The "docker compose" subcommand to run docker-compose does not work
when "docker" is a symlink to "podman" and "docker-compose" is a
symlink to "podman-compose".
Use "docker-compose" instead of the subcommand to support running with
Podman and give a hint in the docs on podman-compose.

remove trailing slash

The most parts are automated now and it should be easy to cut a new
release as long as the instructions are in place.

Signed-off-by: Mathieu Tortuyaux <[email protected]>

there is already a 'contributing' file for Flatcar with almost the same
content.

Signed-off-by: Mathieu Tortuyaux <[email protected]>

Signed-off-by: Mathieu Tortuyaux <[email protected]>

Signed-off-by: Mathieu Tortuyaux <[email protected]>

Signed-off-by: Mathieu Tortuyaux <[email protected]>