Giter Club home page Giter Club logo

Comments (8)

nabadger avatar nabadger commented on June 6, 2024 2

I'll close this for now as it's available on master.

I'm working on some updates to documentation and a new release.

from dex-k8s-authenticator.

nabadger avatar nabadger commented on June 6, 2024

Perhaps we can do this by defining placeholders for each section, providing defaults, but also letting the user supply their own templates to customize the output if required. The path to kubectl could probably be provided / overridden by the configuration file.

The current sections of the page can probably be divided into the following sections:

  • Cert Configuration
  • Token Validation (show groups etc)
  • Kubeconfig configuration
  • Resources / Download links

Would these make sense as the headings for each tab?

from dex-k8s-authenticator.

whereisaaron avatar whereisaaron commented on June 6, 2024

I was thinking a tab for each OS. Since the kubectl download and commands are different for every OS (with some overlap for Mac/Linux). Token validation is in common though, and could come first. (I'd like to extract and format the email address and group list.). Each user only needs one OS tab (at a time), and on selecting that OS tab can see everything they need in one screen.

  • Token Validation
  • Linux
    • kubectl download
    • Cert download
    • Kubeconfig configuration
  • Mac
    • kubectl download
    • Cert download
    • Kubeconfig configuration
  • Windows
    • kubectl download
    • Cert download
    • Kubeconfig configuration

I think it ok to stick with a go template and let users override that template, e.g. using a configmap mapped over the file.

from dex-k8s-authenticator.

nabadger avatar nabadger commented on June 6, 2024

Ok, this makes sense :)

from dex-k8s-authenticator.

nabadger avatar nabadger commented on June 6, 2024

A howto on tabs: https://www.w3schools.com/howto/howto_js_tabs.asp

To recap:

  • Add tabs for Linux, Mac and Windows
  • Re-add '\' esc char for Linux/Mac to allow us to continue the command onto the next line (makes it easier to read)
  • See if we can provide a single 'copy-all-to-clipboard' button - you could copy/paste all commands previously, but the 'copy to clipboard' buttons now break that, due to the alt text

from dex-k8s-authenticator.

nabadger avatar nabadger commented on June 6, 2024

Regarding kubectl installation, we need to clarify this.

Official installation overview: https://kubernetes.io/docs/tasks/tools/install-kubectl

These options differ per OS.

We could do the following

  • Linux: Give instructions to latest stable via cURL
  • Mac: Give cURL instructions and also homebrew
  • Windows: Give Powershell, Chocolatey and cURL instructions

At this point, we should consider whether it's better to just to redirect users to the official installation overview page (not sure). I'm a bit wary that the official guide will get updated, and our instructions could become outdated.

from dex-k8s-authenticator.

whereisaaron avatar whereisaaron commented on June 6, 2024

A link to the official instructions is great. However for some clusters will need a specific version of kubectl. So how about rather that curl instructions, we provide just two links on the per-OS page:

  1. A link to the official install instructions (or a configurable override URL, e.g. to a company Intranet page)
  2. A download link to the appropriate Linux/Mac/Windows binary on the official build archive, with a configurable X.Y.Z version e.g.
    https://storage.googleapis.com/kubernetes-release/release/vX.Y.Z/bin/linux/amd64/kubectl. If no version is configured, just don't display this link.

from dex-k8s-authenticator.

whereisaaron avatar whereisaaron commented on June 6, 2024

For PowerShell the continuation character is backquote, but there must be no whitespace after the backtick (on that line) or it won't work.

For cmd.exe the continuation character is caret (^), but the following newline is removed, so you must have a space before the caret and/or on the beginning of the next line.

from dex-k8s-authenticator.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.