Commit Graph

98 Commits

Author SHA1 Message Date
Matt Moyer
1ab1d41735
Minor cleanups on the new Supervisor+Okta docs page.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-05-24 10:31:06 -05:00
Margo Crawford
36168122cc
Add doc for configuring the supervisor with okta 2021-05-24 10:30:50 -05:00
Pinny
dbde150c38 Update CLI docs for v0.8.0 release 2021-05-10 22:01:16 +00:00
Matt Moyer
f167a075dd
Clean up this language in configure-supervisor-with-gitlab.md a bit more.
This was duplicitive.

Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-05-04 15:49:45 -05:00
Matt Moyer
8136c787a7
More adjustments to configure-supervisor-with-gitlab.md.
- Use `nickname` claim as an example, which means we only need the `openid` scope.
  This is also more stable since emails can change over time.

- Put the OIDCIdentityProvider and Secret into one YAML blob, since they will likely be copy-pasted together anyway.

- Add a separate section for using alternate claims.

- Add a separate section for using a private GitLab instance.

Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-05-04 15:49:45 -05:00
Matt Moyer
3e13b5f39d
Do some minor copyediting on "configure-supervisor-with-gitlab.md".
Some minor edits I came across while reviewing this:

- Capitalize "GitLab" the way they do.

- Use `{{< ref "xyz" >}}` references when linking internally. The advantage of these is that they're "type checked" by Hugo when the site is rendered, so we'll know if we ever break one.

- Add links to the GitLab docs about creating an OAuth client. These also cover adding a group-level or instance-wide application.

- Re-wrap the YAML lines to fit a bit more naturally.

- Add a `namespace` to the YAML examples, so they're more likely to work without tweaks.

- Use "gitlab" instead of "my-oidc-identity-provider" as the example name, for clarity.

- Re-word a few small bits. These are 100% subjective but hopefully an improvement?

Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-05-04 15:49:45 -05:00
Margo Crawford
bed2d2dd62 Incorporated PR feedback 2021-04-28 13:34:36 -07:00
Margo Crawford
96fda6ed13 Added documentation for how to configure the Supervisor with GitLab 2021-04-27 16:18:30 -07:00
Pinny
7b82b7a010 Update CLI docs for v0.7.0 release 2021-04-01 19:15:23 +00:00
Margo Crawford
a537287601 Regenerate cli.md based on output of help message 2021-03-19 14:34:35 -07:00
Margo Crawford
fdfc854f8c Incorporating suggestions:
- a credential that is understood by -> a credential that can be used to
  authenticate to
- This is more neutral to whether its going directly to k8s
  or through the impersonation proxy
2021-03-19 14:06:20 -07:00
Margo Crawford
331fef8fae Tweaked some wording, updated the cli page 2021-03-19 14:06:20 -07:00
Margo Crawford
4470d3d2d1 Fix broken links to architecture page 2021-03-19 14:06:20 -07:00
Margo Crawford
698bffc2ad Naming changes 2021-03-19 14:06:20 -07:00
Margo Crawford
6ff3e42602 Add description of impersonation proxy strategy to docs 2021-03-19 14:06:20 -07:00
Matt Moyer
dd151b3f50
Fix missing titles on website docs.
Also fixes our sitemap to have correct `lastmod` times when built locally (it was already correct on Netlify).

Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-03-01 11:31:27 -06:00
Matt Moyer
2254f76b30
Fix a broken link, a typo, and tweak menu text.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-24 09:23:21 -06:00
Matt Moyer
852c1b7a27
Fix some copy-paste errors on install-supervisor.md.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-23 16:02:27 -06:00
Matt Moyer
7a1d92a8d4
Restructure docs into new layout.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-23 11:11:07 -06:00
Matt Moyer
3721632de2
Move scope doc out of website to SCOPE.md.
This is contributor-focused, so we decided to move it into GitHub only for now.

Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-23 11:11:07 -06:00
Matt Moyer
4de949fe18
Rework docs sidebar to have some nesting.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-23 11:11:07 -06:00
Monis Khan
89b00e3702
Declare war on namespaces
Signed-off-by: Monis Khan <mok@vmware.com>
2021-02-10 21:52:07 -05:00
Matt Moyer
1ceef5874e
Clean up docs using https://get.pinniped.dev redirects.
We have these redirects set up to make the `kubectl apply -f [...]` commands cleaner, but we never went back and fixed up the documentation to use them until now.

Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-01-28 10:15:39 -06:00
Margo Crawford
2686031ac1 Fixing documentation to reference 1.20 generated docs 2021-01-08 15:21:23 -08:00
Andrew Keesler
ef74ba7238
Re-export arch diagram to embed images
I followed the steps in site/content/docs/img/README.md.

Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2021-01-05 08:44:10 -05:00
Andrew Keesler
b4415a05d0
I don't _think_ we need this picture anymore
See f25b4a3.

Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2021-01-05 08:36:26 -05:00
Margo Crawford
f25b4a3e12 De-duped architecture diagram references 2021-01-04 16:47:34 -08:00
Margo Crawford
8422659ee5 Fixed typos and issues with the demo code
- Also cleaned up some wording
2021-01-04 16:23:24 -08:00
Margo Crawford
ef828cf2e1
Add rough draft of supervisor demo
Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2021-01-04 15:31:53 -05:00
Margo Crawford
a005b8dce1
Merge branch 'main' into supervisor-docs 2020-12-18 15:34:34 -08:00
Margo Crawford
6cae776e48 Change image reference on README,
Also clarified some wording between authenticators and identity providers
2020-12-18 15:09:50 -08:00
Margo Crawford
afc39cd2f7 Tweak image descriptions 2020-12-18 14:54:30 -08:00
Matt Moyer
8313ffcf7f
Add "Installing Pinniped" docs page.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2020-12-18 16:44:20 -06:00
Andrew Keesler
0b12b30cb1 Updated diagrams and architecture text
Signed-off-by: Margo Crawford <margaretc@vmware.com>
2020-12-18 14:13:29 -08:00
Matt Moyer
c27d02a929
Fix a typo on the Project Scope page.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2020-12-18 13:48:12 -06:00
Margo Crawford
4dbd8c9cae
Update Concierge-only demo for v0.3.0 release
Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2020-12-18 13:06:09 -05:00
Andrew Keesler
40d93ff33b
site/content/docs/architecture.md: another coat of paint with Supervisor updates
Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2020-12-18 09:39:36 -05:00
Andrew Keesler
1af06bbcc9
De-dup markdown docs by deleting them in site/ tree
I'm not sure if these docs are used anywhere in our website, but I don't think
that they are. I'm assuming someone or something will yell if these should not
be deleted. These docs also live at the root of the repo, and the duplicate
versions are already drifting out of sync from one another.

Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2020-12-18 08:11:14 -05:00
Margo Crawford
2e191084b0 Miscellaneous wording changes 2020-12-17 16:42:45 -08:00
Margo Crawford
28e23e14b5 Demo landing page 2020-12-17 16:08:51 -08:00
Margo Crawford
5f2807e693 Updates to the architecture page. 2020-12-17 15:55:05 -08:00
Rajat Goyal
7e78c9322c Remove duplicate documentation images from the repo and change all links to point to the Hugo site 2020-12-02 23:58:19 +05:30
Jake Knostman
15bffc6b16
Update site demo to use pinniped-concierge namespace 2020-11-20 12:31:23 -08:00
Alexander Brand
406d6b5544
docs/scope.md: Fix link to contrib guide
Signed-off-by: Alexander Brand <alexbrand09@gmail.com>
2020-11-13 15:25:01 -05:00
Alexander Brand
271640b66d
docs/architecture.md: Fix broken link 2020-11-13 09:17:47 -05:00
Alexander Brand
6b0d4184d5
docs/architecture.md: Fix broken link 2020-11-13 09:15:46 -05:00
Jonas Rosland
0b41469527 Website fixes for broken links, formatting, and more
Signed-off-by: Jonas Rosland <jrosland@vmware.com>
2020-11-11 21:40:49 -05:00
Adam Powell
896e1b45f0 Hugo version of Pinniped site 2020-11-06 12:42:57 -10:00