GithubHelp home page GithubHelp logo

bcgov / sso-keycloak Goto Github PK

View Code? Open in Web Editor NEW
12.0 5.0 4.0 6.77 MB

License: Apache License 2.0

Dockerfile 0.43% Java 27.46% FreeMarker 8.16% CSS 1.90% JavaScript 20.62% Makefile 0.84% Mustache 0.66% Shell 2.31% PLpgSQL 0.35% HCL 14.35% Smarty 0.30% HTML 4.84% Roff 0.16% TypeScript 17.36% Python 0.25%
citz bcgov-sso

sso-keycloak's Introduction

sso-keycloak

Lifecycle:Stable

repository for keycloak images and helm chart

Docker image

  • GitHub Packages
  • Tag strategies/conventions

Devhub Docs

Devhub docs are generated using Techdocs, a cli tool. To run locally:

  • npx @techdocs/cli serve --verbose --no-docker

sso-keycloak's People

Contributors

arcshiftsolutions avatar jlangy avatar junmin-bcgov avatar junminahn avatar monicag avatar nithinkuruba avatar thegentlemanphysicist avatar zsamji avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

sso-keycloak's Issues

[Gold Custom]: MOTI

Product Owner Contact Details

[email protected]

Technical Owner Contact Details

[email protected]

Secondary Technical Owner Contact Details

No response

Silver custom realm name

kmas316h

New realm name

moti-custom

Gold environment needed

  • Dev
  • Test
  • Prod

Code of Conduct

  • I agree to follow Pathfinder SSO's Gold Custom Realm Community Ways of Working

It's Been a While Since This Repository has Been Updated

This issue is a kind reminder that your repository has been inactive for 181 days. Some repositories are maintained in accordance with business requirements that infrequently change thus appearing inactive, and some repositories are inactive because they are unmaintained.

To help differentiate products that are unmaintained from products that do not require frequent maintenance, repomountie will open an issue whenever a repository has not been updated in 180 days.

  • If this product is being actively maintained, please close this issue.
  • If this repository isn't being actively maintained anymore, please archive this repository. Also, for bonus points, please add a dormant or retired life cycle badge.

Thank you for your help ensuring effective governance of our open-source ecosystem!

[Gold Custom]: HCAP

Product Owner Contact Details

[email protected]

Technical Owner Contact Details

[email protected]

Secondary Technical Owner Contact Details

[email protected]

Silver custom realm name

4qjrpzzl

New realm name

hcap

Gold environment needed

  • Dev
  • Test
  • Prod

Code of Conduct

  • I agree to follow Pathfinder SSO's Gold Custom Realm Community Ways of Working

WIKI Feedback

I started with the CSS App and went to the "Pathfinder Knowledge Base", then went down the list of links in the Wiki TOC. Did not review Wiki pages that were not linked in the TOC (assumed they are "internal")

CSS FAQ

  • On the CSS home page under "additional technical information" -- "Requires role management, session management, scopes or changes in token times" -- role management is a feature now, so maybe remove that reference

Home Page

  • Is Github in or out? Conflicting messages on this page
  • Talks about standard realm and says custom realm is not allowed -- probably need to mention that custom realms exist per ministry
  • Probably a good place to mention that we are now on Gold and link to service agreement

SSO Onboarding

  • No comment

Using Your SSO Client

  • Links out to CSS FAQ and a discussions page. Now I'm starting to get overwhelmed with number of locations for docs
  • "Environments and Accounts" mentions "Silver" and "Gold" for the first time, but I have not heard of these before in the Knowledge Base

What is Keycloak @ BC Government?

  • This page probably needs an update if Github is back in
  • This page links to "useful references" which mentions Azure IDIR for the first time. I would have thought that would have been on the list of IDPs or mentioned in the list that describes the kc-idp-hint options

BC Service Card Integration

  • Under the expandable "Join an Existing Dedicated Realm on the SSO-KEYCLOAK(formerly OCP-SSO) server" section: References "realm per sector" but talks about it as a possible future strategy -- needs an update

Identity Provider Attribute Mapping

  • Confusing but really worth it. Please keep the "developer" version up to date (it's really confusing when that page doesn't match the visual)

Handling Authorization

  • Links to another page on the Wiki. Just make one page and fix the table of contents please.

Gold Migration Q&A

  • Jumped me to a discussion page which was a bit jarring (I left the Wiki)

Load testing details

  • Test duration: 15 - 30 minutes
  • Namespace: 6d70e7-dev
  • Ramp up time: 1 minute, pushing active sessions until failure threshold
  • Success/Failure: We want to perform a stress test, with failure criteria of 1% of requests failing. i.e increase the active sessions/minute until meeting this threshold
  • Traffic from outside of bcgov network (run locally)
  • k6 test file

Add missing topics

TL;DR

Topics greatly improve the discoverability of repos; please add the short code from the table below to the topics of your repo so that ministries can use GitHub's search to find out what repos belong to them and other visitors can find useful content (and reuse it!).

Why Topic

In short order we'll add our 800th repo. This large number clearly demonstrates the success of using GitHub and our Open Source initiative. This huge success means it's critical that we work to make our content as discoverable as possible. Through discoverability, we promote code reuse across a large decentralized organization like the Government of British Columbia as well as allow ministries to find the repos they own.

What to do

Below is a table of abbreviation a.k.a short codes for each ministry; they're the ones used in all @gov.bc.ca email addresses. Please add the short codes of the ministry or organization that "owns" this repo as a topic.

add a topic

That's it, you're done!!!

How to use

Once topics are added, you can use them in GitHub's search. For example, enter something like org:bcgov topic:citz to find all the repos that belong to Citizens' Services. You can refine this search by adding key words specific to a subject you're interested in. To learn more about searching through repos check out GitHub's doc on searching.

Pro Tip ๐Ÿค“

  • If your org is not in the list below, or the table contains errors, please create an issue here.

  • While you're doing this, add additional topics that would help someone searching for "something". These can be the language used javascript or R; something like opendata or data for data only repos; or any other key words that are useful.

  • Add a meaningful description to your repo. This is hugely valuable to people looking through our repositories.

  • If your application is live, add the production URL.

Ministry Short Codes

Short Code Organization Name
AEST Advanced Education, Skills & Training
AGRI Agriculture
ALC Agriculture Land Commission
AG Attorney General
MCF Children & Family Development
CITZ Citizens' Services
DBC Destination BC
EMBC Emergency Management BC
EAO Environmental Assessment Office
EDUC Education
EMPR Energy, Mines & Petroleum Resources
ENV Environment & Climate Change Strategy
FIN Finance
FLNR Forests, Lands, Natural Resource Operations & Rural Development
HLTH Health
IRR Indigenous Relations & Reconciliation
JEDC Jobs, Economic Development & Competitiveness
LBR Labour Policy & Legislation
LDB BC Liquor Distribution Branch
MMHA Mental Health & Addictions
MAH Municipal Affairs & Housing
BCPC Pension Corporation
PSA Public Service Agency
PSSG Public Safety and Solicitor General
SDPR Social Development & Poverty Reduction
TCA Tourism, Arts & Culture
TRAN Transportation & Infrastructure

NOTE See an error or omission? Please create an issue here to get it remedied.

[Gold Custom]: CSST

Product Owner Contact Details

[email protected]

Technical Owner Contact Details

[email protected]

Secondary Technical Owner Contact Details

[email protected]

Silver custom realm name

jbd6rnxw

New realm name

csst

Gold environment needed

  • Dev
  • Test
  • Prod

Code of Conduct

  • I agree to follow Pathfinder SSO's Gold Custom Realm Community Ways of Working

Add project lifecycle badge

No Project Lifecycle Badge found in your readme!

Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to your project as well as other stakeholders (platform services, executive) insight into the lifecycle of your repository.

What is a Project Lifecycle Badge?

It is a simple image that neatly describes your project's stage in its lifecycle. More information can be found in the project lifecycle badges documentation.

What do I need to do?

I suggest you make a PR into your README.md and add a project lifecycle badge near the top where it is easy for your users to pick it up :). Once it is merged feel free to close this issue. I will not open up a new one :)

[Gold Custom]: CHEFS

Product Owner Contact Details

[email protected]

Technical Owner Contact Details

[email protected]

Secondary Technical Owner Contact Details

No response

Silver custom realm name

cp1qly2d

New realm name

CHEFS

Gold environment needed

  • Dev
  • Test
  • Prod

Code of Conduct

  • I agree to follow Pathfinder SSO's Gold Custom Realm Community Ways of Working

[Gold Custom]: Prime

Product Owner Contact Details

[email protected]

Technical Owner Contact Details

[email protected]

Secondary Technical Owner Contact Details

[email protected]

Silver custom realm name

v4mbqqas

New realm name

PRIME

Gold environment needed

  • Dev
  • Test
  • Prod

Code of Conduct

  • I agree to follow Pathfinder SSO's Gold Custom Realm Community Ways of Working

[Gold Custom]: BCParks

Product Owner Contact Details

[email protected]

Technical Owner Contact Details

[email protected]

Secondary Technical Owner Contact Details

[email protected]

Silver custom realm name

g7v0xlf4

New realm name

BCParks_ServiceTransformation

Gold environment needed

  • Dev
  • Test
  • Prod

Code of Conduct

  • I agree to follow Pathfinder SSO's Gold Custom Realm Community Ways of Working

Lets use common phrasing

TL;DR ๐ŸŽ๏ธ

Teams are encouraged to favour modern inclusive phrasing both in their communication as well as in any source checked into their repositories. You'll find a table at the end of this text with preferred phrasing to socialize with your team.

Words Matter

We're aligning our development community to favour inclusive phrasing for common technical expressions. There is a table below that outlines the phrases that are being retired along with the preferred alternatives.

During your team scrum, technical meetings, documentation, the code you write, etc. use the inclusive phrasing from the table below. That's it - it really is that easy.

For the curious mind, the Public Service Agency (PSA) has published a guide describing how Words Matter in our daily communication. Its an insightful read and a good reminder to be curious and open minded.

What about the master branch?

The word "master" is not inherently bad or non-inclusive. For example people get a masters degree; become a master of their craft; or master a skill. It's generally when the word "master" is used along side the word "slave" that it becomes non-inclusive.

Some teams choose to use the word main for the default branch of a repo as opposed to the more commonly used master branch. While it's not required or recommended, your team is empowered to do what works for them. If you do rename the master branch consider using main so that we have consistency among the repos within our organization.

Preferred Phrasing

Non-Inclusive Inclusive
Whitelist => Allowlist
Blacklist => Denylist
Master / Slave => Leader / Follower; Primary / Standby; etc
Grandfathered => Legacy status
Sanity check => Quick check; Confidence check; etc
Dummy value => Placeholder value; Sample value; etc

Pro Tip ๐Ÿค“

This list is not comprehensive. If you're aware of other outdated nomenclature please create an issue (PR preferred) with your suggestion.

[Gold Custom]: Health Gateway

Product Owner Contact Details

[email protected]

Technical Owner Contact Details

[email protected]

Secondary Technical Owner Contact Details

No response

Silver custom realm name

ff09qn3f

New realm name

Health Gateway Gold

Gold environment needed

  • Dev
  • Test
  • Prod

Code of Conduct

  • I agree to follow Pathfinder SSO's Gold Custom Realm Community Ways of Working

[Gold Custom]: APS

Product Owner Contact Details

[email protected]

Technical Owner Contact Details

[email protected]

Secondary Technical Owner Contact Details

[email protected]

Silver custom realm name

xtmke7ky

New realm name

apigw

Gold environment needed

  • Dev
  • Test
  • Prod

Code of Conduct

  • I agree to follow Pathfinder SSO's Gold Custom Realm Community Ways of Working

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.