This repo contains the documentation for Single Sign-On for PCF, which enables Pivotal Cloud Foundry users to authenticate with an external identity provider rather than having to create a new account or re-enter credentials. Single Sign-On grants users centralized access to applications in various spaces, as well as to Ops Manager, Apps Manager, and other Cloud Foundry components.
| Branch name | Use for… | Publishes to… |
|---|---|---|
| master | This branch is on staging. ADD ALL NEW 2.0 (or 1.10?) CONTENT to this branch. When 1.10 was released, master and v1.10 were identical. | https://docs-pcf-staging.cfapps.io/p-identity/1-n/ |
| master-pws | This branch contains PWS-specific SSO content. The audience is plan administrators and developers; not operators. This content is stale. | https://docs.run.pivotal.io/sso/ |
| 1.10 | This branch contains the published documentation for the v1.10 release of SSO. | https://docs.pivotal.io/p-identity/1-10/ |
| 1.9 | This branch contains the published documentation for the v1.9 release of SSO. | https://docs.pivotal.io/p-identity/1-9/ |
| 1.8 | This branch contains the published documentation for the v1.8 release of SSO. | https://docs.pivotal.io/p-identity/1-8/ |
| 1.7 | This branch contains the published documentation for the v1.7 release of SSO. | https://docs.pivotal.io/p-identity/1-7/ |
| 1.6 | This branch contains the published documentation for the v1.6 release of SSO. | https://docs.pivotal.io/p-identity/1-6/ |
| 1.5 | This branch contains the published documentation for the v1.5 release of SSO. | https://docs.pivotal.io/p-identity/1-5/ |
| 1.4 | Do not update. This branch is obsolete. | https://docs.pivotal.io/archives/docs-identity-1.4.pdf |
| 1.3 | Do not update. This branch is obsolete. | https://docs.pivotal.io/archives/docs-identity-1.3.pdf |
| 1.2 | Do not update. This branch is obsolete. | https://docs.pivotal.io/archives/docs-identity-1.2.pdf |
| 1.1 | Do not update. This branch is obsolete. | https://docs.pivotal.io/archives/docs-identity-1.1.pdf |
| 1.0 | Do not update. This branch is unpublished. The branch contains the documentation for the EOL'd v1.0.10 release of SSO. | |
| master-on-April27 | A temporary snapshot of master to keep while we make large changes to the master branch. Please keep in sync with v1.6. |
- Clone https://github.com/pivotal-cf/docs-layout-repo
- Clone https://github.com/pivotal-cf/docs-book-identity. Check out branch
edgeof this repo, verify that this branch has a config.yml that contains the newest SSO version properties. Create feature branch out ofedgeof to hold changes in sidebar structure and texts. - Clone https://github.com/pivotal-cf/docs-identity. Read the
READMEof this repo to decide which branch to check out. Create feature branch out of the appropriate branch to hold changes in the actual documentation text content. - Get ruby 2.3.0 and follow steps on https://github.com/pivotal-cf/bookbinder
cd docs-book-identity && bundle install- To render the documentation with hotload changes:
cd docs-book-identity && bundle exec bookbinder watch(Browse to localhost url in the output, for example,localhost:4567/p-identity/1-n).
- Check out
masterbranch. - Create a feature branch with a branch name reflecting the purpose of the edit. E.g.:
git checkout -b update-product-version - Commit onto the feature branch, and push the feature branch.
- Create PR to request that the feature branch be merged into
master, and include any appropriate contexts in the PR. - Docs team will review the PR and delete the feature branch once it is merged.
SSO has a lot of difficult and inconsistent terminology. Jane learned the following, working with Peter Chen in early July 2018.
| Term | Variations on Term | Notes |
|---|---|---|
| SSO Operator Dashboard | Use this for the product name, put it in initial caps. | |
| SSO Developer Dashboard | Use this for the product name, put it in initial caps. | |
| SSO Developer Dashboard | dashboard, developer dashboard, SSO dashboard, SSO UI | This is a dashboard with a UI that you log in to. There is a 1:1 between service instances and SSO developer dashboards. There is a many:1 between SSO developer dashboards and UAA identity zones |
| UAA identity zone | Not sure of capitalization for this term. A subset of UAA. There is a 1:1 between plan and UAA Identity Zone. | |
| UAA identity zone client | many | There are two kinds of UAA Identity Zone client: admin client and non-admin clients. |
| UAAC vs UAAC CLI | User Account and Authentication Command Line Interface (UAAC) spell out first use | The UAAC is released, production quality that we discuss in the docs |
| UAA CLI | UAA-CLI | The UAAC CLI is an experimental CLI ("incubating"). It is different from the UAAC, which is released. Don't discuss UAA CLI in the docs. |
| PCF app | Use this for apps that are hosted on PCF. | |
| externally hosted app | Use this for apps that are hosted externally. | |
| native apps | Native apps are mobile, desktop, or commandline apps. This is a different categorization from "PCF app vs externally hosted app". The most common native app is the mobile app. We wrote "native apps, such as mobile apps". Info from Tian, 2018.12.04 |