No description, website, or topics provided.
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cli auto-generated PKS CLI docs v1.3.0-build.125 Jan 7, 2019
images Fix graphic Jan 15, 2019
LEGAL.txt refactor pks book Nov 17, 2017
README.md Add sentence from previous versions [#163263187] Jan 18, 2019
_add-clusters-workloads.html.md.erb [#161571101] additional clarifications about stemcell, textsmithing Nov 14, 2018
_apply-changes.html.md.erb Update content specific to Ops Man v2.2 [#162616813] Dec 18, 2018
_azs-networks-azure.html.md.erb fix typo Jan 8, 2019
_azs-networks.html.md.erb Merge PKS restructure branch into master [#159340850] Aug 10, 2018
_beta-component.html.md.erb Adds partial for beta components [#158224753] Jun 13, 2018
_bosh-ssh.html.md.erb cleanup of missing whitespace [#163135365] Jan 12, 2019
_cloud-provider.html.md.erb Fix link text to retitled procedural topics [#160740504] Sep 26, 2018
_configure-auth.html.md.erb Fix links to retitled procedural topics [#160740504] Sep 26, 2018
_errands.html.md.erb fixing formatting [#163062356] Jan 8, 2019
_harbor.html.md.erb make cli install and api config steps in install procs [#163041381] Jan 12, 2019
_install-cli.html.md.erb Merge PKS restructure branch into master [#159340850] Aug 10, 2018
_install-pks.html.md.erb Merge PKS restructure branch into master [#159340850] Aug 10, 2018
_lb-resource-config.html.md.erb Add more info about LB field in resource config [#161933983] Jan 18, 2019
_logging.html.md.erb clarify syslog as BOSH logs and sinks as PKS/k8s logs [#162706701] Jan 9, 2019
_login-pks-api.html.md.erb Update pointer to login topic [#157122054] Apr 30, 2018
_monitoring.html.md.erb Update screenshots and fix text issues [#162768958] Jan 3, 2019
_pks-api.html.md.erb Update screenshots and fix text issues [#162768958] Jan 3, 2019
_plans.html.md.erb Remove additional outdated references [#163107269] Jan 10, 2019
_prerequisites.html.md.erb Fix heading translation from Markdown to HTML Dec 14, 2018
_share-endpoint.html.md.erb Fix links to retitled procedural topics [#160740504] Sep 26, 2018
_uaa.html.md.erb Correct obvious spelling errors Jan 4, 2019
_usage-data.html.md.erb Add introductory information [#162272070] Dec 13, 2018
_vrealize-logs.html.md.erb fixing typo [#161389457] Oct 30, 2018
about-lb.html.md.erb Add Azure topic to referring pages and update GCP/AWS titles [#162271… Dec 26, 2018
access-dashboard.html.md.erb improve accessing dashboard topic[#162858526] Dec 27, 2018
aws-api-load-balancer.html.md.erb Clarify internal LB step [#161944107] Jan 11, 2019
aws-cluster-load-balancer.html.md.erb replaced lb naming suggestion with cluster name [#161943896] Jan 17, 2019
aws-index.html.md.erb add notes to clarify terraform vs manual[#162701765] Jan 8, 2019
aws-requirements.html.md.erb Update Amazon resource requirements [#161933977] Jan 11, 2019
azure-api-load-balancer.html.md.erb replace lengthy next steps with link back to install proc [#163041381] Jan 15, 2019
azure-cluster-load-balancer.html.md.erb changing line per feedback [#163062356] Jan 8, 2019
azure-index.html.md.erb fixes topic order Jan 8, 2019
azure-managed-identities.html.md.erb Issue 507: making the 2 changes Jan 9, 2019
azure-om-config.html.md.erb changing next step [#163062356] Jan 9, 2019
azure-om-deploy.html.md.erb adds env_short_name and links to the service principal app step [#162… Dec 19, 2018
azure-prepare-env.html.md.erb update availability set info[#162822864] Jan 3, 2019
azure-requirements.html.md.erb add notes clarifying manual/terraform[#162927746] Jan 4, 2019
backup-and-restore.html.md.erb light edit on pks bbr pr[#163300382] Jan 17, 2019
bbr-backup-cluster.html.md.erb light edit on pks bbr pr[#163300382] Jan 17, 2019
bbr-backup.html.md.erb Edit for formatting [#161092749] Oct 11, 2018
bbr-install.html.md.erb Edit for formatting [#161092749] Oct 10, 2018
bbr-logging.html.md.erb remove exit code info from PKS BBR docs[#160328371] Sep 17, 2018
bbr-restore-cluster.html.md.erb light edit on pks bbr pr[#163300382] Jan 17, 2019
bbr-restore.html.md.erb Edit for style and formatting [#161092749] Oct 10, 2018
cluster-credentials.html.md.erb Fix formatting in Notes Sep 25, 2018
concepts.html.md.erb add missing links to concepts index page [#162706701] Jan 10, 2019
configure-api.html.md.erb rm 'TLS' from title [#160991076] Oct 4, 2018
configure-ingress.html.md.erb add ingress topic and add link to it from managing index[#162277877] Dec 7, 2018
configure-tiller-helm.html.md.erb Retitle procedural topics [#160740504] Sep 25, 2018
configuring-pvs.html.md.erb Merge branch 'lparis-pvs-edits-additional' [#161073024] Oct 9, 2018
control-plane.html.md.erb Update section name [#160833999] Sep 27, 2018
create-cluster.html.md.erb Add Azure topic to referring pages and update GCP/AWS titles [#162271… Dec 26, 2018
create-sinks.html.md.erb adds more x-linking [#162706701] Jan 10, 2019
custom-workloads.html.md.erb update adding custom workloads topic[#162833679] Dec 24, 2018
delete-cluster.html.md.erb Remove additional outdated references [#163107269] Jan 10, 2019
delete.html.md.erb Update content specific to Ops Man v2.2 [#162616813] Dec 18, 2018
deploy-workloads.html.md.erb Get spec.ip custom label Oct 31, 2018
diagnostic-tools.html.md.erb diagnostic tools revisions [#163135365] Jan 11, 2019
download-logs.html.md.erb Retitle procedural topics [#160740504] Sep 25, 2018
gcp-api-load-balancer.html.md.erb Update content specific to Ops Man v2.2 [#162616813] Dec 18, 2018
gcp-cluster-load-balancer.html.md.erb Add Azure topic to referring pages and update GCP/AWS titles [#162271… Dec 26, 2018
gcp-index.html.md.erb add notes to clarify terraform vs manual[#162701765] Jan 8, 2019
gcp-requirements.html.md.erb add notes clarifying manual/terraform[#162927746] Jan 4, 2019
gcp-service-accounts.html.md.erb Update GCP prereqs [#161637299] Dec 7, 2018
generate-nsx-ca-cert.html.md.erb [#161968394] synching all the titles Nov 15, 2018
generate-nsx-pi-cert.html.md.erb Correct obvious spelling errors Jan 4, 2019
helm.html.md.erb Remove link to Istio topic [#163038890] Jan 8, 2019
index.html.md.erb Update table to indicate Harbor can be used with PKS on GCP and AWS Jan 16, 2019
installing-kubectl-cli.html.md.erb rip tabbed tables [#155294677] Feb 17, 2018
installing-nsx-t.html.md.erb make cli install and api config steps in install procs [#163041381] Jan 12, 2019
installing-pks-aws.html.md.erb Add more info about LB field in resource config [#161933983] Jan 18, 2019
installing-pks-azure.html.md.erb Add more info about LB field in resource config [#161933983] Jan 18, 2019
installing-pks-cli.html.md.erb adding info around what it means to be executable [#161225275] Oct 17, 2018
installing-pks-gcp.html.md.erb Add more info about LB field in resource config [#161933983] Jan 18, 2019
installing-pks-vsphere.html.md.erb make cli install and api config steps in install procs [#163041381] Jan 12, 2019
installing.html.md.erb Azure documentation first steps Nov 27, 2018
interruptions.html.md.erb Fix links to retitled procedural topics [#160740504] Sep 26, 2018
log-out.html.md.erb Retitle procedural topics [#160740504] Sep 25, 2018
maintain-uptime.html.md.erb Edit PR #484 [#162718744] Dec 26, 2018
manage-deployments-bosh.html.md.erb feedback cleanup [#163135365] Jan 11, 2019
manage-users.html.md.erb fix broken link Jan 15, 2019
managing.html.md.erb Update topic title [#163043662] Jan 15, 2019
monitor-etcd.html.md.erb Reorder paragraph Sep 27, 2018
monitor-sinks.html.md.erb adding k8s.event examples [#163136490] Jan 16, 2019
monitor.html.md.erb Test pipelines 2 Jan 18, 2019
network-profiles-define.html.md.erb Fix JSON formatting [#163193370] Jan 16, 2019
network-profiles.html.md.erb Edit PR and re-structure topic [#163040825] Jan 10, 2019
nsxt-create-objects.html.md.erb [#161968394] synching all the titles Nov 15, 2018
nsxt-deploy.html.md.erb update x-links to include new topic [#163100626] Jan 11, 2019
nsxt-multi-pks.html.md.erb Edits from NM Dec 21, 2018
nsxt-multi-t0.html.md.erb Updates to supported NSX-T versions Jan 10, 2019
nsxt-prepare-compute-plane.html.md.erb [#161968394] synching all the titles Nov 15, 2018
nsxt-prepare-env.html.md.erb update x-links to include new topic [#163100626] Jan 11, 2019
nsxt-prepare-mgmt-plane.html.md.erb update x-links to include new topic [#163100626] Jan 11, 2019
nsxt-topologies.html.md.erb [#161968394] synching all the titles Nov 15, 2018
pas-and-pks.html.md.erb Brush up wording [#159447159] Oct 26, 2018
pks-api-auth.html.md.erb Add AWS to list environments [#160836769] Sep 27, 2018
ports-protocols-nsx-t.html.md.erb Add ports and protocols reqs [#162506198] Dec 10, 2018
proxies.html.md.erb edit pr[#162777118] Dec 21, 2018
release-notes.html.md.erb update rn Jan 16, 2019
scale-clusters.html.md.erb Correct statement about maximum number of worker nodes [#161825319] Jan 2, 2019
security-process.html.md.erb [#157953791] style, acronym convention edits May 30, 2018
security.html.md.erb Adds security landing page [#158046481] Jun 15, 2018
sink-architecture.html.md.erb adds more x-linking [#162706701] Jan 10, 2019
telemetry.html.md.erb Add new metrics for Telemetry [#160393857] Oct 17, 2018
troubleshoot-issues.html.md.erb clarifying [#161943190] Jan 17, 2019
troubleshoot.html.md.erb fixes broken links Feb 8, 2018
understanding-upgrades.html.md.erb Remove additional outdated references [#163107269] Jan 10, 2019
upgrade-pipeline.html.md.erb Retitle procedural topics [#160740504] Sep 25, 2018
upgrade-pks-nsxt.html.md.erb add post-upgrade step to update clis [#163041381] Jan 15, 2019
upgrade-pks.html.md.erb add post-upgrade step to update clis [#163041381] Jan 15, 2019
upgrading.html.md.erb Fix links to retitled procedural topics [#160740504] Sep 26, 2018
using.html.md.erb Update topic title [#160866862] Oct 3, 2018
verify-health.html.md.erb Remove additional outdated references [#163107269] Jan 10, 2019
view-cluster-details.html.md.erb Retitle procedural topics [#160740504] Sep 25, 2018
view-cluster-list.html.md.erb Retitle procedural topics [#160740504] Sep 25, 2018
view-cluster-plans.html.md.erb Retitle procedural topics [#160740504] Sep 25, 2018
view-usage-data.html.md.erb Small edit based on feedback Jan 18, 2019
vm-sizing.html.md.erb Merge branch 'lparis-troubleshooting-updates' into 1.2 Oct 25, 2018
volumes.html.md.erb Merge branch 'lparis-pvs-edits-additional' [#161073024] Oct 9, 2018
vsphere-index.html.md.erb Revert "Revert "Update vSphere index [#161637277]"" Jan 16, 2019
vsphere-nsxt-index.html.md.erb Edits, adjustments, formatting, etc. Jan 8, 2019
vsphere-nsxt-om-config.html.md.erb Remove outdated references [#163107269] Jan 10, 2019
vsphere-nsxt-om-deploy.html.md.erb Correct obvious spelling errors Jan 4, 2019
vsphere-nsxt-requirements.html.md.erb Point to release notes for NSX-T version info; add clarification stat… Jan 11, 2019
vsphere-nsxt-rpd-mpd.html.md.erb missed a few [#163100626] Jan 11, 2019
vsphere-persistent-storage.html.md.erb Edit for style and formatting [#163234160] Jan 15, 2019
vsphere-prepare-env.html.md.erb Revert "Revert "Update links [#161637277]"" Jan 16, 2019
vsphere-requirements.html.md.erb Change anchor [#161637277] Jan 12, 2019

README.md

Pivotal Container Service (PKS) Documentation

This repo contains the content for the documentation for Pivotal Container Service (PKS).

The content in this repo publishes to the PKS documentation site at https://docs.pivotal.io/runtimes/pks/index.html.

How To Contribute

Please help us improve the accuracy and completeness of the PKS documentation by contributing.

The easiest way to contribute is to file a pull request through GitHub.

Every topic in the PKS documentation site has a corresponding file in this repo. Locate the correct file and make a pull request against it. You can also navigate to the topic in the PKS documentation site and click "View the source for this page in GitHub" at the bottom of the topic.

Versions and Branching

Branch Name Content Location
master PKS 1.4.x pre-release content N/A
1.3 PKS 1.3.x released content https://docs.pivotal.io/runtimes/pks/1-3/index.html
1.2 PKS 1.2.x released content https://docs.pivotal.io/runtimes/pks/1-2/index.html
1.1 PKS 1.1.x released content https://docs.pivotal.io/runtimes/pks/1-1/index.html
1.0-publish Not in use N/A
0.8 Not in use N/A

The master branch is used to publish the pre-release v1.4 version of the site. Create pull requests on master to contribute bug fixes or correct technical inaccuracies in the v1.4 documentation. This documentation requires validation. Contact #pcf-docs on Pivotal Slack for access.

The 1.3 branch is used to publish the live v1.3 version of the site. Create pull requests on 1.3 to contribute bug fixes or correct technical inaccuracies in the v1.3 documentation.

The 1.2 branch is used to publish the live v1.2 version of the site. Create pull requests on 1.2 to contribute bug fixes or correct technical inaccuracies in the v1.2 documentation.

The 1.1 branch is used to publish the live v1.1 version of the site. Create pull requests on 1.1 to contribute bug fixes or correct technical inaccuracies in the v1.1 documentation.

The 1.0-publish and 0.8 branches are no longer maintained. A PDF of the PKS v1.0 documentation is available at https://docs.pivotal.io/archives/pks-docs-1.0.pdf.

How To Use Bookbinder To View Your Docs

Bookbinder is a command-line utility for stitching Markdown docs into a hostable web app. The PCF Docs Team uses Bookbinder to publish our documentation sites, but you can also use Bookbinder to view a live version of your documentation on your local machine.

Bookbinder draws the content for the site from this repo, the left navigation menu ("subnav") from docs-book-pks, and various layout configuration and assets from docs-layout-repo.

To use Bookbinder to view your documentation, perform the following steps:

  1. Clone this repo to the ~/workspace directory on your local machine.
  2. Clone docs-book-pks and docs-layout-repo to the ~/workspace directory on your local machine.
  3. Change into the docs-book-pks directory.
  4. Run bundle install to install all of the necessary gems, including Bookbinder.
  5. Build your documentation site with bookbinder in one of the two following ways:
  • Run bundle exec bookbinder watch to build an interactive version of the docs and navigate to localhost:4567/myservice/ in a browser. (It may take a moment for the site to load at first.) This builds a site from your content repo at docs-content, and then watches that repo to update the site if you make any changes to the repo.
  • Run bundle exec bookbinder bind local to build a Rack web-app of the book. After the bind has completed, cd into the final_app directory and run rackup. Then navigate to localhost:9292/myservice/ in a browser.