{"id":20725203,"url":"https://github.com/sighupio/gangplank","last_synced_at":"2025-08-10T19:20:43.370Z","repository":{"id":227889388,"uuid":"764549135","full_name":"sighupio/gangplank","owner":"sighupio","description":"Gangplank is a Kubernetes UI to get a working kubeconfig via oidc","archived":false,"fork":false,"pushed_at":"2024-06-17T14:50:31.000Z","size":1530,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-06-21T08:20:52.536Z","etag":null,"topics":["authentication","fury-distribution","kubernetes","oidc-client"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sighupio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-28T09:29:02.000Z","updated_at":"2024-06-17T14:49:09.000Z","dependencies_parsed_at":"2024-06-21T07:21:07.125Z","dependency_job_id":"8f4f8f5c-9ca3-49f4-af25-5f8dc34d3c81","html_url":"https://github.com/sighupio/gangplank","commit_stats":null,"previous_names":["sighupio/gangplank"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sighupio%2Fgangplank","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sighupio%2Fgangplank/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sighupio%2Fgangplank/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sighupio%2Fgangplank/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sighupio","download_url":"https://codeload.github.com/sighupio/gangplank/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224996781,"owners_count":17404528,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["authentication","fury-distribution","kubernetes","oidc-client"],"created_at":"2024-11-17T04:17:54.334Z","updated_at":"2024-11-17T04:17:54.901Z","avatar_url":"https://github.com/sighupio.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gangplank\n\n_(noun): A board or ramp used as a removable footway between a ship and a pier._\n\nGangplank is a web application that allows users to authenticate with an OIDC provider and configure their `kubectl` configuration file with the [OpenID Connect Tokens](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens). Gangplank is based on [Gangway](https://github.com/vmware-archive/gangway), which is no longer maintained.\n\n![Gangplank screenshot](docs/images/screenshot.png)\n\n## Deployment\n\nGangplank can be deployed with Helm or with Kubernetes manifests.\n\nThe Helm chart can be found [here](deployments/helm/README.md).\n\nInstructions for deploying with Kubernetes manifests can be found [here](docs/README.md).\n\nContainer images are published to our registry at `registry.sighup.io/fury/gangplank`.\n\n## How It Works\n\nKubernetes supports OpenID Connect (OIDC) as a user authentication mechanism. OIDC is an\nauthentication protocol that allows servers to verify the identity of a user by way of an ID Token.\n\nWhen using OIDC to authenticate with Kubernetes, the client (e.g. `kubectl`) sends the ID token\nalongside all requests to the API server. On the server side, the Kubernetes API server verifies the\ntoken to ensure it is valid and has not expired. Once verified, the API server extracts username and\ngroup membership information from the token, and continues processing the request.\n\nIn order to obtain the ID token, the user must go through the OIDC authentication process. This is\nwhere Gangplank comes in. Gangplank is a web application that enables the OIDC authentication flow which\nresults in the minting of the ID Token.\n\nGangplank is configured as a client of an upstream Identity Service that speaks OIDC. To obtain the ID\ntoken, the user accesses Gangplank, initiates the OIDC flow by clicking the \"Log In\" button, and\ncompletes the flow by authenticating with the upstream Identity Service. The user's credentials are\nnever shared with Gangplank.\n\nOnce the authentication flow is complete, the user is redirected to a Gangplank page that provides\ninstructions on how to configure `kubectl` to use the ID token.\n\nThe following sequence diagram details the authentication flow:\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"docs/images/gangplank-sequence-diagram.png\" width=\"600px\" /\u003e\n\u003c/p\u003e\n\n## Kubernetes API Server\n\nGangplank requires that the Kubernetes API server is configured to use OIDC for authentication, check the following link for more information: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#configuring-the-api-server\n\n## Build\n\nThe project uses [asdf](https://github.com/asdf-vm/asdf) to manage the build tools. After installing the required tools, the following command will build the Gangplank binary and the container image:\n\n```bash\nmake build\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsighupio%2Fgangplank","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsighupio%2Fgangplank","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsighupio%2Fgangplank/lists"}