cloudfoundry / docs-running-cf Goto Github PK

View Code? Open in Web Editor NEW

9.0 52.0 69.0 15.1 MB

A place for docs related to running, monitoring, and troubleshooting a Cloud Foundry deployment

License: Apache License 2.0

HTML 100.00%

docs-running-cf's Introduction

Operating Cloud Foundry

This is a guide for operators on running and troubleshooting a Cloud Foundry instance.

This repository is one of several content repositories that go into a complete documentation set.

The contents here are structured as a topic repository intended to be compiled into a larger document with Bookbinder.

See the docs-book-cloudfoundry repo for the complete list of open source documentation repositories, as well as information about the publishing process.

docs-running-cf's People

Contributors

Stargazers

Watchers

docs-running-cf's Issues

StagingStartRequestsReceived Metric incorrect/not emitted

Hi CF docs team,

We were looking at the Diego stager metrics and noticed that the StagingStartRequestsReceived metric is incorrect. We believe the correct metric is stage.request or staging.requested.

https://github.com/cloudfoundry/docs-running-cf/blob/master/metrics/_diego.html.md.erb#L216

Best,
Mirah and @gmrodgers

Missing description of space quotas

Space quotas were delivered on Aug 18 2014, but don't yet appear onto https://docs.cloudfoundry.org/running/managing-cf/quota-plans.html into https://github.com/cloudfoundry/docs-running-cf/blob/0b1a0d91574e26f9c9fbc5acb6581a6d65a16c5c/managing-cf/quota-plans.html.md.erb

Details of the epic and completed stories:
https://www.pivotaltracker.com/epic/show/1292082

Output of CLI related support

$ cf help
[...]
SPACE ADMIN:
   space-quotas                           List available space resource quotas
   space-quota                            Show space quota info
   create-space-quota                     Define a new space resource quota
   update-space-quota                     update an existing space quota
   delete-space-quota                     Delete a space quota definition and unassign the space quota from all spaces
   set-space-quota                        Assign a space quota definition to a space
   unset-space-quota                      Unassign a quota from a space

Usage and audit events docs should be updated to describe v3 endpoints instead of v2

The usage events and audit events documentation pages both describe how to use v2 endpoints to retrieve events. Per the cloud controller API docs, these endpoints are deprecated (see here and here) and API clients are encouraged to use the v3 endpoints instead.

We should update these two docs pages to use v3 endpoints instead of v2.

cf-release is mentioned even though it's deprecated

docs-running-cf/managing-cf/logging.html.md.erb

Line 16 in e640c99

In `cf-release`, the components are all configured in a similar way:

Any reference to cf-release should be changed to refer to cf-deployment.

cf deploy cf-deployment v15.1.0 failed with vm nats/$(instanceId} failing with --ps metrics-discovery-registrar failing

I did following:

bosh-deployment using github repo from gh repo clone cloudfoundry/bosh-deployment using bosh-lite. On AWS. Succeed and the single instance launched with no error

$bosh create-env bosh-deployment/bosh.yml --state=state.json --vars-store=creds.yml -o bosh-deployment/aws/cpi.yml -o bosh-deployment/bosh-lite.yml -o bosh-deployment/bosh-lite-runc.yml -o bosh-deployment/jumpbox-user.yml -o bosh-deployment/external-ip-with-registry-not-recommended.yml -v director_name=bosh-1 -v internal_cidr=10.0.0.0/24 -v internal_gw=10.0.0.1 -v internal_ip=10.0.0.6 -v access_key_id=${myKeyId} -v secret_access_key=${myKey} -v region=ap-southeast-1 -v az=ap-southeast-1c -v default_key_name=bosh -v default_security_groups=[bosh] --var-file private_key=${myPemPath} -v subnet_id=${myAwsSubnetId} -v external_ip=${aws_elastic_ip}

cf-deployment using gh repo clone cloudfoundry/cf-deployment

$bosh -e bosh-lite -d cf deploy cf-deployment/cf-deployment.yml -o cf-deployment/operations/bosh-lite.yml --vars-store deployment-vars.yml -v system_domain=${aws_elastic_ip}.sslip.io

The Cloud Foundry deployment run for ~ 50 minutes installing a lot of VMs. And failed with some status.

From bosh instances --ps, it does report most VMs instance running in green except for the VM instance name "nats/${vmId}" with process name "metrics-discovery-registrar" error.

$bosh -e bosh-lite -d cf instances --ps

Instance Process Process State AZ IPs
api/3e996907-6701-4891-9e5c-247fb665f021 - running z1 10.244.0.133
cc-worker/765b6ce4-f6fd-44f9-85b8-cca314a8f6e8 - running z1 10.244.0.134
credhub/2b5967cd-0ccd-4648-be47-aa3e1a876030 - running z1 10.244.0.140
database/b2cf85e1-ef8a-4225-a5a1-6fc76195fc60 - running z1 10.244.0.129
diego-api/e33a1c1c-69c4-4b15-82f5-1ebd709e339f - running z1 10.244.0.130
diego-cell/c5b5d0cf-b427-45cd-bceb-4afc4b575002 - running z1 10.244.0.138
doppler/203f3eec-4200-459b-95dd-fbc1301876c3 - running z1 10.244.0.137
log-api/d407c05b-708b-4f8b-915e-edcf95fa01e6 - running z1 10.244.0.139
nats/894d2ca9-e18a-43b2-a1ea-049d7c5dc669 - failing z1 10.244.0.128
~ loggr-forwarder-agent running - -
~ loggr-syslog-agent running - -
~ loggregator_agent running - -
~ metrics-agent running - -
~ metrics-discovery-registrar unknown - -
~ nats running - -
~ nats-tls running - -
~ prom_scraper running - -
rotate-cc-database-key/b4cfe754-accd-42b6-b1ac-a387d20f46b4 - - z1 -
router/1144e8db-dd07-4ee3-96f6-b3feae1c8a7d - running z1 10.244.0.34
scheduler/b07d9ce3-0b5a-4db6-bc5d-7fd0761d7644 - running z1 10.244.0.135
singleton-blobstore/7d1eeed4-51e1-47f3-989f-7dd20adf581a - running z1 10.244.0.132
smoke-tests/585412a3-ac1c-4a42-b7ea-a303ca00ecf5 - - z1 -
tcp-router/5f150b72-54cd-4cee-8735-ce588c517ceb - running z1 10.244.0.136

I ssh into the problematic nats/${vmId" and monit status. Attempted monit restart all process but it still failed at "metrics-discovery-registrat"

_nats/894d2ca9-e18a-43b2-a1ea-049d7c5dc669:/root# monit restart all
nats/894d2ca9-e18a-43b2-a1ea-049d7c5dc669:/root# monit summary
The Monit daemon 5.2.5 uptime: 1h 9m

Process 'nats' running
Process 'nats-tls' running
Process 'loggregator_agent' running
Process 'loggr-forwarder-agent' running
Process 'loggr-syslog-agent' running
Process 'prom_scraper' running
Process 'metrics-discovery-registrar' not monitored
Process 'metrics-agent' initializing
System 'system_localhost' initializing
nats/894d2ca9-e18a-43b2-a1ea-049d7c5dc669:/root#_

Attempted on AWS Security Group's Inbound Rule to add in Custom TCP Rule for the port 4222, port 4223, port 4224 with just to be sure i not missing out. Retry above step with same issue with nats/$vmId} failing for same process "metrics-discovery-registrar" error

Welcome anyone who can help

CC API 429 errors missing from list of error codes

Hi everyone,

We noticed the other day that the 429 errors that Cloud Controller returns when a user has been rate limited are not included in the following list of error codes:
https://docs.cloudfoundry.org/running/troubleshooting/error-codes.html

It is mentioned on this page, however:
https://docs.cloudfoundry.org/running/rate-limit-cloud-controller-api.html

We just found the list of error codes through a web search so I'm not sure if it's still a maintained list or not, just wanted to let you all know.

Thanks! 👍

cc api rate limiting docs incomplete

Hello docs team. These docs around CC API rate-limiting are a little incomplete/misleading: https://docs.cloudfoundry.org/running/rate-limit-cloud-controller-api.html

They say that rate limiting is by IP, but this only true if no user is authenticated. If the CF client has authenticated a UAA user, then rate limiting is per UAA user.
We clarified this with CAPI on slack:
https://cloudfoundry.slack.com/archives/C07C04W4Q/p1490720207020633

CF Logging Document refers to cf-release and metron-agent

Noticed the docs on this page are outdated and need a refresh.

Probably best to reach out to the Loggregator team to rewrite this page.
CF-Release references should certainly be removed.
Reach out to Release Integration as well if you need anything more/different than the Loggregarians can provide.

So. Yeah.

Syslog Drain Binder may not exist anymore

docs-running-cf/managing-cf/logging-config.html.md.erb

Lines 444 to 538 in 89744b3

 ### <a id='syslog-drain-binder'></a> Syslog Drain Binder 

 See [Using Log Management Services](../../devguide/services/log-management.html). 

 <table> 

 <tr> 

 <th><strong>Property Name</strong></th> 

 <th><strong>Description</strong></th> 

 <th><strong>Default</strong></th> 

 </tr> 

 <td>metron_endpoint.host</td> 

 <td>Host used to emit messages to the Metron agent</td> 

 <td><code>127.0.0.1</code></td> 

 </tr> 

 <tr> 

 <td>metron_endpoint.dropsonde_port</td> 

 <td>Port used to emit dropsonde messages to the Metron agent</td> 

 <td><code>3457</code></td> 

 </tr> 

 <tr> 

 <td>loggregator.etcd.require_ssl</td> 

 <td>Boolean value to enable SSL for all communication with ETCD</td> 

 <td><code>false</code></td> 

 </tr> 

 <tr> 

 <td>loggregator.etcd.machines</td> 

 <td>IP addresses pointing to the ETCD cluster</td> 

 <td>no default</td> 

 </tr> 

 <tr> 

 <td>loggregator.etcd.maxconcurrentrequests</td> 

 <td>Maximum number of concurrent requests to ETCD</td> 

 <td><code>10</code></td> 

 </tr> 

 <tr> 

 <td>loggregator.etcd.ca_cert</td> 

 <td>PEM-encoded CA certificate</td> 

 <td>no default</td> 

 </tr> 

 <tr> 

 <td>syslog_drain_binder.etcd.client_cert</td> 

 <td>PEM-encoded client certificate</td> 

 <td>no default</td> 

 </tr> 

 <tr> 

 <td>syslog_drain_binder.etcd.client_key</td> 

 <td>PEM-encoded client key</td> 

 <td>no default</td> 

 </tr> 

 <tr> 

 <td>system_domain</td> 

 <td>Domain reserved for Cloud Foundry operator, and the base URL where login, UAA, and other non-user apps listen </td> 

 <td>no default</td> 

 </tr> 

 <tr> 

 <td>syslog_drain_binder.drain_url_ttl_seconds</td> 

 <td>Time to live (TTL), in seconds, for drain URLs</td> 

 <td><code>60</code></td> 

 </tr> 

 <tr> 

 <td>syslog_drain_binder.update_interval_seconds</td> 

 <td>Interval, in seconds, on which to poll Cloud Controller</td> 

 <td><code>15</code></td> 

 </tr> 

 <tr> 

 <td>syslog_drain_binder.polling_batch_size</td> 

 <td>Batch size for the poll from Cloud Controller</td> 

 <td><code>1000</code></td> 

 </tr> 

 <tr> 

 <td>syslog_drain_binder.debug</td> 

 <td>Boolean value to enable verbose logging for syslog_drain_binder</td> 

 <td><code>false</code></td> 

 </tr> 

 <tr> 

 <td>syslog_drain_binder.locked_memory_limit</td> 

 <td>Shell's locked memory limit size. Accepts numeric values interpreted as KsB, or the following non-numeric values: <code>kernel</code>, <code>soft</code>, <code>hard</code>, <code>unlimited</code>. <code>kernel</code> sets limit to the kernel's default.</td> 

 <td><code>unlimited</code></td> 

 </tr> 

 <tr> 

 <td>cc.bulk_api_password</td> 

 <td>Password for the bulk API</td> 

 <td>no default</td> 

 </tr> 

 <tr> 

 <td>cc.srv_api_uri</td> 

 <td>API URI of Cloud Controller</td> 

 <td>no default</td> 

 </tr> 

 <tr> 

 <td>ssl.skip_cert_verify</td> 

 <td>Boolean value to ignore bad SSL certificates when connecting over https</td> 

 <td><code>false</code></td> 

 </tr> 

 </table>

cf api - does not list the endpoint

$ cf api
No api endpoint set. Use 'cf api' to set an endpoint

==
I am trying to view my end point and I thought that this tells my end point .
What is the exact command to get my end point ?

	### <a id='syslog-drain-binder'></a> Syslog Drain Binder

	See [Using Log Management Services](../../devguide/services/log-management.html).

	<table>
	<tr>
	<th><strong>Property Name</strong></th>
	<th><strong>Description</strong></th>
	<th><strong>Default</strong></th>
	</tr>
	<td>metron_endpoint.host</td>
	<td>Host used to emit messages to the Metron agent</td>
	<td><code>127.0.0.1</code></td>
	</tr>
	<tr>
	<td>metron_endpoint.dropsonde_port</td>
	<td>Port used to emit dropsonde messages to the Metron agent</td>
	<td><code>3457</code></td>
	</tr>
	<tr>
	<td>loggregator.etcd.require_ssl</td>
	<td>Boolean value to enable SSL for all communication with ETCD</td>
	<td><code>false</code></td>
	</tr>
	<tr>
	<td>loggregator.etcd.machines</td>
	<td>IP addresses pointing to the ETCD cluster</td>
	<td>no default</td>
	</tr>
	<tr>
	<td>loggregator.etcd.maxconcurrentrequests</td>
	<td>Maximum number of concurrent requests to ETCD</td>
	<td><code>10</code></td>
	</tr>
	<tr>
	<td>loggregator.etcd.ca_cert</td>
	<td>PEM-encoded CA certificate</td>
	<td>no default</td>
	</tr>
	<tr>
	<td>syslog_drain_binder.etcd.client_cert</td>
	<td>PEM-encoded client certificate</td>
	<td>no default</td>
	</tr>
	<tr>
	<td>syslog_drain_binder.etcd.client_key</td>
	<td>PEM-encoded client key</td>
	<td>no default</td>
	</tr>
	<tr>
	<td>system_domain</td>
	<td>Domain reserved for Cloud Foundry operator, and the base URL where login, UAA, and other non-user apps listen </td>
	<td>no default</td>
	</tr>
	<tr>
	<td>syslog_drain_binder.drain_url_ttl_seconds</td>
	<td>Time to live (TTL), in seconds, for drain URLs</td>
	<td><code>60</code></td>
	</tr>
	<tr>
	<td>syslog_drain_binder.update_interval_seconds</td>
	<td>Interval, in seconds, on which to poll Cloud Controller</td>
	<td><code>15</code></td>
	</tr>
	<tr>
	<td>syslog_drain_binder.polling_batch_size</td>
	<td>Batch size for the poll from Cloud Controller</td>
	<td><code>1000</code></td>
	</tr>
	<tr>
	<td>syslog_drain_binder.debug</td>
	<td>Boolean value to enable verbose logging for syslog_drain_binder</td>
	<td><code>false</code></td>
	</tr>
	<tr>
	<td>syslog_drain_binder.locked_memory_limit</td>
	<td>Shell's locked memory limit size. Accepts numeric values interpreted as KsB, or the following non-numeric values: <code>kernel</code>, <code>soft</code>, <code>hard</code>, <code>unlimited</code>. <code>kernel</code> sets limit to the kernel's default.</td>
	<td><code>unlimited</code></td>
	</tr>
	<tr>
	<td>cc.bulk_api_password</td>
	<td>Password for the bulk API</td>
	<td>no default</td>
	</tr>
	<tr>
	<td>cc.srv_api_uri</td>
	<td>API URI of Cloud Controller</td>
	<td>no default</td>
	</tr>
	<tr>
	<td>ssl.skip_cert_verify</td>
	<td>Boolean value to ignore bad SSL certificates when connecting over https</td>
	<td><code>false</code></td>
	</tr>
	</table>

cloudfoundry / docs-running-cf Goto Github PK

docs-running-cf's Introduction

Operating Cloud Foundry

docs-running-cf's People

Contributors

Stargazers

Watchers

Forkers

docs-running-cf's Issues

Recommend Projects

Recommend Topics

Recommend Org