CSS-10401 cleanup repo #1331
CSS-10401 cleanup repo #1331
Conversation
kian99
force-pushed
the
CSS-10401-cleanup-repo
branch
from
7f09a8e
to
9ab9eff
Compare
README.md
Outdated
| Subsequently JIMM introduced a large shift in how the service worked: | ||
| - JIMM now acts as a proxy between all client and Juju controller interactions. Previously | ||
| users were redirected to a Juju controller. | ||
| - Juju controllers trust a public key served by JIMM. |
There was a problem hiding this comment.
This can be confusing, they trust JWT (insert what algo we use here) cryptography
There was a problem hiding this comment.
Reoworded to just "Juju controllers support JWT login where secure tokens are issued by JIMM."
kian99
force-pushed
the
CSS-10401-cleanup-repo
branch
from
9ab9eff
to
1e373f9
Compare
|
|
||
| At this point, from the root of this branch, run the command: | ||
| `make install` | ||
| ## Dependencies |
There was a problem hiding this comment.
what do you think about adding a small drawing in the readme? I can create it in another pr.
example.
There was a problem hiding this comment.
We have a nice diagram in our JAAS docs, but I like this idea. We can add one in a follow-up.
|
|
||
| - jemd: start the JIMM server; | ||
| - jaas-admin: perform admin commands on JIMM; | ||
| A brief explanation of the various services that JIMM depends on is below: |
There was a problem hiding this comment.
i think Jimm depends also on "juju"
There was a problem hiding this comment.
Good point, but I think that's implied by the fact that JIMM acts as a layer on top of Juju. And JIMM can run without Juju present but it can't start with OpenFGA, Postgres and Vault.
|
|
||
| The project uses Go modules (https://golang.org/cmd/go/#hdr-Module_maintenance) to manage Go | ||
| dependencies. **Note: Go 1.11 or greater needed.** | ||
| JIMM/JAAS provides enterprise level functionality layered on top of your Juju controller like: |
There was a problem hiding this comment.
functionalities? And I'd probably just remove the "like" bit
| - jimmsrv: The JIMM server. | ||
| - jimmctl: A CLI tool for administrators of JIMM to view audit logs, manage permissions, etc. | ||
| Available as a snap. | ||
| - jaas: A plugin for the Juju CLI, extend the base set of command with extra functionality when |
|
|
||
| Further, to better align the two projects, JIMM's versioning now aligns with Juju. | ||
|
|
||
| As a result of this, there is no JIMM v2 and instead from JIMM v3, the versioning strategy |
|
@ale8k Thanks, I'll fix those last 3 comments in a follow-up. |
no worries! |
* improve readme and supporting docs * PR tweaks * Add a line explaining building/publishing section * put jimm history in a separate doc * add project links
Description
Note: This PR builds on #1330.
This PR updates JIMM's README to be more accurate to the current state of affairs. It also splits out the testing instructions into a separate CONTRIBUTING.md file.
Partially addresses CSS-10401
Engineering checklist
Check only items that apply