pivotal-cf/docs-ops-guide

Documentation for Cloud Foundry operators

docs-ops-guide

Operator docs for Ops Manager v2.6 and earlier.

Note: For Ops Manager v2.7 and later, these docs are located in docs-ops-manager/opsguide.

Which book repos publish this repo?

The docs-book-pivotalcf repo publishes this repo.

Which branch to use?

Note: Provide instructions in your PRs to indicate which branches you want Docs to apply your commits to.

Branch name	Use for…
master	Not in use
2.6	EOGS v2.6.x.
2.5	EOGS v2.5.x.
2.4	EOGS v2.4.x.
2.3	EOGS v2.3.x.
2.2	v2.2.x — PDFed: https://resources.docs.pivotal.io/pdfs/pcf-docs-2.2.pdf
2.1	v2.1.x — PDFed: https://resources.docs.pivotal.io/pdfs/pcf-docs-2.1.pdf
2.0	v2.0.x — PDFed: https://resources.docs.pivotal.io/pdfs/pcf-docs-2.0.pdf
1.12	v2.0.x — PDFed: https://resources.docs.pivotal.io/pdfs/pcf-docs-2.0.pdf
1.11	v2.0.x — PDFed: https://resources.docs.pivotal.io/pdfs/pcf-docs-2.0.pdf
1.10	v2.0.x — PDFed: https://resources.docs.pivotal.io/pdfs/pcf-docs-2.0.pdf
1.9	v2.0.x — PDFed: https://resources.docs.pivotal.io/pdfs/pcf-docs-2.0.pdf

Partials

Cross-product and repo partials are single sourced from the docs-partials repo.

Style Guide

See Word and Phrase List.

Steps for local development

$ git clone [email protected]:pivotal-cf/docs-layout-repo
$ git clone [email protected]:pivotal-cf/docs-ops-guide
$ cd docs-ops-guide && git checkout <branch> && cd -
$ git clone [email protected]:pivotal-cf/docs-book-pivotalcf
$ cd docs-book-pivotalcf && git checkout <branch>
$ bundle install
$ bundle exec bookbinder watch
$ open http://127.0.0.1:XXXX/platform/<version, such as `2-10`>/customizing

docs-ops-guide's Issues

Zendesk reference link is broken on this page - PCF 2.3

This is for PCF 2.3 topic Configure LDAP as an Identity Provider for PAS. There is a reference link provided on how to configure LDAP as mentioned below, which is broken. It has to be updated.

https://discuss.zendesk.com/hc/en-us/articles/204140418-Configuring-LDAP-Integration-with-Pivotal-Cloud-Foundry-

Outdated Scaling Recommendations

The Scaling Recommendations Table is outdated and not complete.
https://docs.pivotal.io/pivotalcf/2-0/opsguide/scaling-ert-components.html

It misses following components:

• Filestorage
• Backup Prepare Node
• MySQL Monitor
• Cloud Controller Worker
• Syslog Adapter
• TCP Router
• Credhub

For Clock Global the recommended HA number is 2, while the default PAS 2.0 deployment sets this to 1.

Enabling volum services documentation incomplete

We just enabled volume services on our elastic runtime v1.10.3-build.6 installation. The docs say

"After completing these steps, developers can use the cf CLI to create service instances of the nfs service and bind them to their apps."

Yet when creating a volume service, a configuration object must be passed as argument. Otherwise the command cf create-service nfs Existing fails.

Also the docs are unclear about whether the nfs service is part of the elastic runtime installation, or if a nfs server has to be set up by the user. In case it is part of the installation, the docs should say where to find the ip of the nfs server.

This page (https://docs.cloudfoundry.org/devguide/services/using-vol-services.html) says that the command should be as follows:

cf create-service nfs Existing nfs_service_instance -c '{"share": "10.10.10.10/export/myshare"}'

Looking at the vms managed by bosh for the elastic runtime deployment, one can see an nfs_server vm. I guess this is the IP that we should be using for the create-service command. But what is the mountpoint in PCF 1.10?

Also further configuration must be passed when binding a volume service to an app. Open source CF docs give this example:

cf bind-service my-app nfs_service_instance -c '{"uid":"1000","gid":"1000","mount":"/var/volume1"}'

This should also be explained in the PCF docs.

Apache NIFI as a PCF service

Hi,
I am just curious to know that is there any way to use Apache NIFI as service in Pivotal Cloud Foundry.
If it is,then how can we achieve it.What are the steps that we should follow.
Please give your valuable suggestions for the above.
Thank you,
Mohan.V

Windows deployment guide is outdated/wrong

The "Diego for Windows" guide (https://docs.pivotal.io/pivotalcf/1-7/opsguide/deploying-diego.html) is wrong. It references downloads that are unavailable. The current version pf pcf seems to include a ops manager package - far different from what the doc outlines.

Including Container Metrics in Syslog Drains links to staging docs

This link ref points to staging which results in a password prompt.

docs-ops-guide/logging-config-opsman.html.md.erb

Line 70 in ff2b00b

For more information, see [Including Container Metrics in Syslog Drains](https://docs-pcf-staging.cfapps.io/pivotalcf/2-1/devguide/deploy-apps/streaming-logs.html#container-metrics) in the _Application Logging in Cloud Foundry_ topic.

Securing Services Instance Credentials with Runtime CredHub will NOT work unless the resource count for credhub is > 0

By default the instance count for credhub is 0. If you enable Secure Service Credentials without raising this number to at least 1, the service tiles will fail to install (like MySQL and RabbitMQ). They will fail because they will unable to resolve the bosh-dns record for credhub (since it does not exist). I think at least a Note or Warning here that says "if you enable this you need to change the resource config" is merited.

NFS Errand can be used to deploy a broker

Hi

The page http://docs.pivotal.io/pivotalcf/1-12/opsguide/enable-vol-services.html says:

Note: You must have an NFS server running to enable NFS volume services. 
If you want to use NFS and do not currently have a server available, 
you can deploy the test NFS server bundled with the NFS Volume release.

There is actually an Errand that deploys an NFS broker - NFS Broker Errand for Pivotal Elastic Runtime. Running this Errand is probably the simplest solution when there isn't one already available (although doesn't let you configure the resources etc)

Github link wrong

Just went to create a PR to update a page and it took me to the wrong github repo - http://github.com/pivotal-cf/docs-operating-pas/tree/2.7/external-user-management.html.md.erb. Please update to use this repo. Thanks

Configuring Logging in PAS - image is still ERT rather than PAS

Hi,

On page http://docs.pivotal.io/pivotalcf/2-0/opsguide/logging-config-opsman.html#syslog-forward
the image still shows ERT verbiage instead of PAS.

I'm supplying an image I took of the PAS verbiage (although it is probably not a drop-in replacement for what is there now).

External User Management page for LDAP/SAML seems confusing and out of date

The doc page for adding users via LDAP/SAML some contradictory, and out of date for 1.10.

For instance, the note in step 1 says not to use the CF CLI, or UAAC, but in step 2 this note is immediately contradicted by the fact you are using the CF CLI and UAAC CLI.

Additionally, as of CF CLI v6.23.0 (1.10 Apps Manager has you download v6.26.0), we now have the ability to skip all the CF CLI + UAAC instructions in favor of a single CF CLI command the admin can execute.

LDAP

$ cf create-user [email protected] --origin ldap

SAML

$ cf create-user [email protected] --origin <whatever-provider-name-you-set-in-ops-man>

Then the admin can go about creating orgs, assigning rights to the new user, etc., before the user tries to sign in.

The docker registry proxy configuration is ambiguous about needing to be applied

It appears that the change required to configure a proxy for a docker registry needs to be applied to become effective. The docs are ambiguous: https://docs.pivotal.io/pivotalcf/1-12/opsguide/docker-registry.html#proxy

I think that this section could be more clear about how/why this change needs to be applied because it isn't entirely obvious.

Item 4 vSphere link leads to Assure information. Link should lead to vSphere information.

Item 4 vSphere link leads to Assure information. Link should lead to vSphere information.

Steps missing in example for adding existing LDAP users.

In the page https://github.com/pivotal-cf/docs-ops-guide/blob/1.9/external-user-management.html.md.erb Step 2 of Step 2 states to do a curl to add existing Users to the CCDB, it doesn't show you how to get to the point where you can do that.

I'd change the text on step two to something like:
2. Taking the User's SAML or LDAP GUID from step 1, create a User record in the Cloud Controller Database using the USERS API.

cf target https://api.YOUR-SYSTEM-DOMAIN
cf login
export OAUTH-TOKEN=$(cf oauth-token|cut -d ' ' -f 2)

curl "https://api.YOUR-SYSTEM-DOMAIN/v2/users" -d '{
"guid": "YOUR-USER-GUID"
}' -X POST \
-H "Authorization: bearer $OAUTH-TOKEN" \
-H "Host: api.YOUR-SYSTEM-DOMAIN" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Cookie: "

Enable TCP Routing clarity on IaaS changes

@dlresende and I were running through acceptance to Enable TCP routing.

We found the steps on this page https://docs.pivotal.io/pivotalcf/2-6/opsguide/tcp-routing-ert-config.html to be quite difficult to follow. We would suggest:

1. Mention method of updating (cf cli vs GUI) at the start of the instructions. This will then affect the following steps
2. Generic steps are mixed with IaaS specific steps, which makes understanding a bit confusing. Maybe well separating what's generic from what's IaaS specific would help, e.g.

• Generic step description

  • AWS/GCP: Do this
  • vSphere: Do this

• Second generic step description

  • AWS: do this
  • GCP: do that
  • vSphere: do the other