├── .gitignore
├── CODEOWNERS
├── Gemfile
├── LICENSE
├── NOTICE
├── README.md
├── config.yml
├── config
└── template_variables.yml
├── docker
├── Dockerfile
├── README.md
├── docker-compose.yml
└── files
│ └── Gemfile
├── manifest.yml
├── master_middleman
└── source
│ ├── 404.html.erb
│ ├── contribute.html.md.erb
│ ├── googlefb873635f2f14682.html
│ ├── images
│ ├── Pipe_NavBar.png
│ ├── Pipe_gBar.png
│ ├── bg-crowd.png
│ ├── bg-plain-x.jpg
│ ├── bg_social_footer.png
│ ├── cf-icons.png
│ ├── facebook_large.png
│ ├── favicon.ico
│ ├── gplus_large.png
│ ├── hr-horizontal-dark.png
│ ├── hr-vertical.png
│ ├── ico-cancel-x.png
│ ├── ico-search.png
│ ├── logo-footer-pivotal.png
│ ├── logo-pws.png
│ ├── logo_org.png
│ ├── new_logo_org.png
│ ├── pws-logo-dark-bg.png
│ ├── pws-logo-light-bg.png
│ ├── ribbon_forkme.png
│ ├── searchsprite.png
│ ├── twitter_large.png
│ └── youtube_large.png
│ ├── index.html.md.erb
│ ├── javascripts
│ ├── book.js
│ ├── page_initializers
│ │ └── documentation.js.erb
│ ├── vendor
│ │ └── mermaid.js
│ └── waypoints
│ │ ├── context.js
│ │ ├── group.js
│ │ ├── noframeworkAdapter.js
│ │ ├── sticky.js
│ │ └── waypoint.js
│ ├── layouts
│ ├── _additional-scripts.erb
│ ├── _book-footer.erb
│ ├── _pre-content.erb
│ └── layout.erb
│ ├── owners.json.erb
│ ├── search.html.erb
│ ├── stylesheets
│ ├── book-styles.scss
│ ├── partials
│ │ ├── _book-base-values.scss
│ │ └── _book-vars.scss
│ └── vendor
│ │ └── mermaid.scss
│ └── subnavs
│ └── _cf-subnav.erb
├── redirects.rb
└── run.sh
/.gitignore:
--------------------------------------------------------------------------------
1 | output
2 | final_app
3 | .bundle
4 | Gemfile.lock
5 | final_app/*
6 | cached_shas.yml
7 | **/.sass-cache/*
8 | bin
9 | vendor
10 | [#]*[#]
11 | .DS_Store
12 | .ruby-version
13 | .vscode/
--------------------------------------------------------------------------------
/CODEOWNERS:
--------------------------------------------------------------------------------
1 | * @cloudfoundry/wg-app-runtime-platform-docs-approvers
2 |
--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source 'http://rubygems.org'
2 | gem 'therubyracer'
3 | gem 'bookbindery', "9.12.1"
4 | gem 'rake'
5 | gem 'jasmine'
6 | gem 'font-awesome-sass', '4.7.0'
7 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/NOTICE:
--------------------------------------------------------------------------------
1 | Copyright (c) 2015-Present CloudFoundry.org Foundation, Inc. All Rights Reserved.
2 |
3 | Copyright (c) 2012-2105 Pivotal Software, Inc. All Rights Reserved.
4 |
5 | Licensed under the Apache License, Version 2.0 (the "License");
6 | you may not use this file except in compliance with the License.
7 | You may obtain a copy of the License at
8 |
9 | http://www.apache.org/licenses/LICENSE-2.0
10 |
11 | Unless required by applicable law or agreed to in writing, software
12 | distributed under the License is distributed on an "AS IS" BASIS,
13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | See the License for the specific language governing permissions and
15 | limitations under the License.
16 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Cloud Foundry Documentation
2 |
3 | This project publishes the Cloud Foundry documentation as a web application.
4 |
5 | This repository uses the [Bookbindery gem](http://github.com/pivotal-cf/docs-bookbinder) to generate the documentation as a web application. The Bookbinder gem has been tested with the following Ruby versions:
6 |
7 | * 2.5.3
8 | * 2.5.5
9 | * 2.6.3
10 | * 2.6.6
11 | * 2.6.8
12 |
13 | The config.yml file contains the list of topic repositories.
14 |
15 | The master_middleman folder contains the layouts, styles, and subnav used to create the web pages.
16 |
17 | This repository does not contain the documentation content. Documentation content is contained in the topic repositories listed in the config.yml.
18 |
19 | ## Topic Repositories
20 |
21 | The following list describes the topic repositories that make up the Cloud Foundry documentation set
22 |
23 | * [Cloud Foundry Concepts](http://github.com/cloudfoundry/docs-cloudfoundry-concepts): Underlying concepts and architecture
24 | * [Cloud Foundry Command-Line Interface (cf CLI)](https://github.com/cloudfoundry/docs-cf-cli): A guide to the cf CLI for Cloud Foundry developers and users
25 | * [Developer Guide](http://github.com/cloudfoundry/docs-dev-guide): Step-by-step instructions and reference material for developers pushing applications to Cloud Foundry
26 | * [Deploying Cloud Foundry](http://github.com/cloudfoundry/docs-deploying-cf): Instructions for operators using BOSH to deploying Cloud Foundry on AWS, vSphere, vCloud, OpenStack, etc.
27 | * [Running Cloud Foundry](http://github.com/cloudfoundry/docs-running-cf): Information for operators running Cloud Foundry
28 | * [Administrator Tools](https://github.com/cloudfoundry/docs-cf-admin): Documentation about operating Cloud Foundry deployments using BOSH and the cf command line tool
29 | * [Services](http://github.com/cloudfoundry/docs-services): Information about extending Cloud Foundry with custom services, and the service broker API
30 | * [Buildpacks](http://github.com/cloudfoundry/docs-buildpacks): Guides to developing your own buildpacks
31 | * [Loggregator](http://github.com/cloudfoundry/docs-loggregator): Information about the user application logging subsystem of Cloud Foundry
32 | * [User Account and Authentication](https://github.com/cloudfoundry/uaa): Information about the Cloud Foundry User Account and Authentication (UAA) Server
33 |
34 | ## Contributing Pull Requests
35 |
36 | To submit a pull request to the documentation, follow this process:
37 |
38 | 1. Make sure you have a signed CLA. Even if you aren't contributing running code, we still need a Contributor License Agreement.
39 |
40 | 1. Fork the content repository you want to make a contribution to. See the following examples:
41 | * For the Buildpacks Docs at http://docs.cloudfoundry.org/buildpacks/index.html, the content repository is: https://github.com/cloudfoundry/docs-buildpacks.
42 | * For the Developer Guide Docs at http://docs.cloudfoundry.org/devguide/services/, the content repository is: https://github.com/cloudfoundry/docs-dev-guide
43 |
44 | 1. Clone your fork of the content repository. Make sure to clone your fork of the topic repository to a directory that is a sibling to this book repository. So, for example, if you are contributing content to the Buildpack documentation, your folder structure would look like this:
45 |
46 |
63 |
64 | > **Tip:** If you run into issues with `libv8` on macOS, try following [these steps](https://gist.github.com/fernandoaleman/868b64cd60ab2d51ab24e7bf384da1ca#gistcomment-3081153) using a **non-system** version of Ruby ([`rbenv`](https://github.com/rbenv/rbenv) recommended).
65 | > **Tip:** If you run into issues with the installation of Ruby 2.6.8 on macOS Ventura, try following [steps](docker/README.md) and run it inside a container.
66 |
67 | Bookbinder attempts to assemble the doc set from your local copies.
68 | It skips any topic repositories that you do not have checked out. For more information about Bookbinder, see the Bookbinder README.
69 |
70 |
71 | 1. Point your browser at localhost:4567 to preview your changes. On save, your browser will reload with any additional changes you make.
72 |
73 | 1. Commit your changes, rebase from upstream, and push to your fork.
74 |
75 | 1. Submit a pull request (PR) from your fork to the original repositories.
76 |
77 | The CF Docs team will review and merge the PR. They may contact you with questions or edit the PR for formatting and style.
78 | **Note**: After your pull request is merged, your changes appear on [docs.cloudfoundry.org](http://docs.cloudfoundry.org) the next time the cf-docs team pushes updates to the production docs. Updates go live at least once a week.
79 |
80 | ## Determine Content Repositories and Branches of a Book
81 |
82 | The `config.yml` defines the content repositories for each book.
83 | The `config.yml` file of each book contains the list of content repositories and branches that appear in the doc set.
84 | In the `config.yml` file, each content repository is specified in the `repository` subsection.
85 | This subsection includes an optional `ref` key-value pair which defines the branch of the content repository that the book uses.
86 |
87 | Make sure that you are adding your content to the correct branches of the content repositories.
88 |
89 | To determine which branch of a content repository that a book version uses:
90 |
91 | 1. Confirm that you are on the correct book branch. For example, the currently published doc might be on the `main` branch
92 | or on the branch corresponding to its version number.
93 |
94 | 2. Open the `config.yml` file.
95 |
96 | 3. Search for the name of the content repository, for example, `docs-cloudfoundry-concepts`.
97 |
98 | 4. Review the `repository` subsection for the content repository. If there is no `ref:` tag, then the repository uses the main branch. If there is a `ref` key-value pair, it specifies the branch name of the content repository. For example:
99 |
100 | ```
101 | - repository:
102 | name: cloudfoundry/docs-cloudfoundry-concepts
103 | ref: '225'
104 | ```
105 |
106 | `ref: '225'` refers to the 225 branch of the docs-cloudfoundry-concepts repository. Cloud Foundry `225` is associated with v255 of cf-release.
107 | `1.5`, `2.2` and `4.5` map to cf-deployment releases.
108 |
--------------------------------------------------------------------------------
/config.yml:
--------------------------------------------------------------------------------
1 | ---
2 | book_repo: cloudfoundry/docs-book-cloudfoundry
3 |
4 | broken_link_exclusions: iefix|arrowhead
5 | repo_link_enabled: true
6 |
7 | public_host: docs.cloudfoundry.org
8 |
9 | sections:
10 | - repository:
11 | name: cloudfoundry/docs-buildpacks
12 | ref: master
13 | directory: buildpacks
14 | subnav_template: cf-subnav.erb
15 | dependent_sections:
16 | - repository:
17 | name: cloudfoundry-samples/pong_matcher_grails
18 | no_docs: true
19 | - repository:
20 | name: cloudfoundry-samples/pong_matcher_groovy
21 | no_docs: true
22 | - repository:
23 | name: cloudfoundry-samples/pong_matcher_spring
24 | no_docs: true
25 | - repository:
26 | name: cloudfoundry-samples/pong_matcher_ruby
27 | no_docs: true
28 | - repository:
29 | name: cloudfoundry/docs-bbr
30 | ref: master
31 | directory: bbr
32 | subnav_template: cf-subnav.erb
33 | - repository:
34 | name: cloudfoundry/docs-cf-admin
35 | ref: master
36 | directory: adminguide
37 | subnav_template: cf-subnav.erb
38 | - repository:
39 | name: cloudfoundry/docs-cf-cli
40 | ref: master
41 | directory: cf-cli
42 | subnav_template: cf-subnav.erb
43 | - repository:
44 | name: cloudfoundry/docs-cloudfoundry-concepts
45 | ref: master
46 | directory: concepts
47 | subnav_template: cf-subnav.erb
48 | - repository:
49 | name: cloudfoundry/docs-credhub
50 | ref: master
51 | directory: credhub
52 | subnav_template: cf-subnav.erb
53 | - repository:
54 | name: cloudfoundry/docs-deploying-cf
55 | ref: master
56 | directory: deploying
57 | subnav_template: cf-subnav.erb
58 | dependent_sections:
59 | - repository:
60 | name: cloudfoundry/cf-release
61 | no_docs: true
62 | - repository:
63 | name: cloudfoundry/docs-dev-guide
64 | ref: master
65 | directory: devguide
66 | subnav_template: cf-subnav.erb
67 | dependent_sections:
68 | - repository:
69 | name: cloudfoundry-samples/pong_matcher_spring
70 | no_docs: true
71 | - repository:
72 | name: cloudfoundry/docs-loggregator
73 | ref: master
74 | directory: loggregator
75 | subnav_template: cf-subnav.erb
76 | - repository:
77 | name: cloudfoundry/docs-running-cf
78 | ref: master
79 | directory: running
80 | subnav_template: cf-subnav.erb
81 | - repository:
82 | name: cloudfoundry/docs-services
83 | ref: master
84 | directory: services
85 | subnav_template: cf-subnav.erb
86 | - repository:
87 | name: cloudfoundry/docs-uaa
88 | ref: master
89 | directory: uaa
90 | subnav_template: cf-subnav.erb
91 |
--------------------------------------------------------------------------------
/config/template_variables.yml:
--------------------------------------------------------------------------------
1 | ---
2 | template_variables:
3 | book_title: Cloud Foundry Documentation
4 | book_title_short: Cloud Foundry Docs
5 | title: Cloud Foundry Documentation
6 | title_image: ../images/logo_org.png
7 | hero_text: Documentation to help you deploy and manage Cloud Foundry
8 | url_path: https://docs.cloudfoundry.org
9 | product_link:
10 | product_url: https://github.com/cloudfoundry/cf-release
11 | support_link: Get Involved
12 | support_call_to_action: Get Involved
13 | support_url: https://www.cloudfoundry.org/community/
14 | gtm_account_id: GTM-MM86KCJ
15 |
16 | # Product variables
17 | platform_name: Cloud Foundry
18 | platform_old: Cloud Foundry
19 | platform_code: CF
20 | product_code: CF
21 | product_name_lc: cf
22 | app_runtime_first: Cloud Foundry
23 | app_runtime_full: Cloud Foundry
24 | app_runtime: Cloud Foundry
25 | app_runtime_abbr: Cloud Foundry
26 | app_runtime_abbr_lc: cf
27 | k8s_runtime_first: Cloud Foundry
28 | k8s_runtime_full: Cloud Foundry
29 | k8s_runtime: Cloud Foundry
30 | k8s_runtime_abbr: Cloud Foundry
31 | windows_runtime_first: Cloud Foundry
32 | windows_runtime_full: Cloud Foundry
33 | windows_runtime: Cloud Foundry
34 | windows_runtime_abbr: CF
35 | company_name: Cloud Foundry
36 |
37 | # Current version for partials
38 | current_major_version: "10-0"
39 |
40 | # Deprecated variables -- replace with current product variables when possible
41 | product_name: Cloud Foundry
42 | product_runtime: Cloud Foundry
43 | product_short: Cloud Foundry
44 |
45 | # Book content variables
46 | add_volumes_link: For more information, see [Adding Volume Services to your Deployment](../../running/deploy-vol-services.html).
47 | admin_read_only_role: "
Admin Read-Only: Read-only access to all Cloud Controller API resources. Assigned the cloud_controller.admin_read_only scope in UAA.
"
48 | admin_role: "
Admin: Perform operational actions on all orgs and spaces using the Cloud Controller API. Assigned the cloud_controller.admin scope in UAA.
"
49 | admin: Cloud Foundry administrator
50 | api_endpoint_book: For more information, see [Identifying your Cloud Foundry API Endpoint and Version](http://docs.cloudfoundry.org/running/cf-api-endpoint.html).
51 | api_endpoint: the URL of the Cloud Controller in your Cloud Foundry instance
52 | api_v1_format: v1 format
53 | api_v2_format: v2 format
54 | api_version: To determine your Cloud Controller API version, see [Identifying your Cloud Foundry API Endpoint and Version](http://docs.cloudfoundry.org/running/cf-api-endpoint.html).
55 | app_domain: shared-domain.example.com
56 | app_healthcheck_timeout: In Cloud Foundry, the default timeout is 60 seconds and the default maximum configurable timeout is 180 seconds. Your Cloud Foundry operator can set other values for these defaults.
57 | app_logging_footnote: App Logging in Cloud Foundry
58 | app_sec_group_desc: description |This is an optional field that contains useful text for operators to manage security group rules. This field is available in Cloud Foundry v238 and later.
59 | app_sec_groups_default: Only allowing outbound connections to public addresses from app containers. This is the original default. Admins can change this behavior by configuring ASGs.
60 | app_sec_groups_link: For more information about ASGs, see [App Security Groups](../adminguide/app-sec-groups.html).
61 | app_sec_groups: App Security Groups
62 | asg_notifications_prereq:
63 | az: availability zones
64 | azs:
65 | azure_deploy: For more information, see [Preparing to Deploy on Azure](../../deploying/azure/index.html).
66 | bbr_ert:
67 | bbr_space:
68 | bbr_rn_intro:
69 | bbr_rn_compatibility:
70 | billing_manager_role_note:
Note The Billing Manager role is only relevant for Cloud Foundry environments deployed with a billing engine.
71 | billing_manager_role: "
Org Billing Managers: Create and manage billing account and payment information.
Note By default, Cloud Foundry does not enable Cloud Controller request logging. To enable this feature, you must set the cc.security_event_logging.enabled property in your Cloud Foundry manifest to true and redeploy.
75 | cfdot_kb: When logged into a VM hosting an app, you can use tools like the Cloud Foundry Diego Operator Toolkit (cfdot) to run app status diagnostics. For more information, see the [cfdot](https://github.com/cloudfoundry/cfdot) repository on GitHub and the [cfdot CLI](https://docs.cloudfoundry.org/running/monitoring-test.html#cfdot) section of the _Monitoring and Testing Diego Components_ topic.
76 | cipher_suites: You can override the default cipher suites by changing the `router.cipher_suites` and `router.min_tls_version` BOSH manifest properties.
77 | cli_download: https://github.com/cloudfoundry/cli#downloads
78 | cli_v6: Getting Started with the cf CLI
79 | Cloud Foundry has used two architectures for managing application containers:
80 | cloud_controller_dea_agent:
81 | cloud_controller_dea_algorithm:
82 | cloud_controller_logging: For more information about how Cloud Foundry aggregates and streams logs and metrics, see [Overview of Logging and Metrics](../../loggregator/data-sources.html).
83 | collector_singleton: The singleton Collector and Compilation components do not affect platform availability.
84 | concepts_sf_vs_full_header:
85 | concepts_product_model_header:
86 | concepts_product_model_image:
87 | small_footprint_comparison:
88 | concepts_product_model_text: "./overview_model"
89 | console_2: If you have a Cloud Foundry account, see [Identifying your Cloud Foundry API Endpoint and Version](http://docs.cloudfoundry.org/running/cf-api-endpoint.html) to determine the URL of the Cloud Controller in your Cloud Foundry instance. Click **Manage Cloud...** to add this URL to your Cloud Foundry account. Validate the account and continue through the wizard.
90 | console_links:
91 | contact_support:
92 | container_metrics: "This property is set to true by default in your [BOSH release](https://github.com/cloudfoundry/cf-syslog-drain-release/blob/v6.x/jobs/adapter/spec#L61-L66).
Once `scalablesyslog.adapter.metrics_to_syslog_enabled` is set to `true`, run the following cf CLI command to include container metrics in your syslog drain:
YOUR-SYSLOG-DRAIN is the name of your syslog drain.
DRAIN-URL is the URL of your syslog drain.
"
93 | container_network_link: For information about administering container-to-container network policies, see Configuring Container-to-Container Networking.
94 | cookies_shared_domain_1:
95 | cookies_shared_domain_2: For an app using a shared domain such as `example.com`, a cookie set to use the highest domain has a `Domain` attribute of `.example.com` in its HTTP response header.
96 | credhub_link: CredHub
97 | cse_id: 005804290371689664731:9jhxguhn8dy
98 | custom_load_balancer:
99 | custom_services: If you are interested in building services for Cloud Foundry and making them available to end users, see Services.
100 | custom_stack_nav_link: "* Adding a Custom Stack "
101 | custom_stack: You can also build your own custom stack. For more information, see [Adding a Custom Stack](../../running/custom-stack.html).
102 | dea_diego_table_row:
103 | dea_diego_version: Diego architecture
104 | default_asgs: |-
105 |
Default ASGs
106 |
107 | Cloud Foundry preconfigures two ASGs: `public_networks` and `dns`.
108 |
109 | Unless you modify these before your initial deployment, these ASGs are applied by default to all containers in your deployment.
110 |
111 | * `public_networks`: This group allows access to public networks, and blocks access to private networks and link local addresses. Cloud
112 | Foundry blocks outgoing traffic to the following IP address ranges by specifically allowing traffic to all other addresses:
113 | * 10.0.0.0 - 10.255.255.255
114 | * 169.254.0.0 - 169.254.255.255
115 | * 172.16.0.0 - 172.31.255.255
116 | * 192.168.0.0 - 192.168.255.255
117 |
118 | * `dns`: This group allows access to DNS on port 53 for any IP address. The default ASGs are defined in the `cf-deployment.yml` file as follows:
119 |
120 | ```
121 | security_group_definitions:
122 | - name: public_networks
123 | rules:
124 | - destination: 0.0.0.0-9.255.255.255
125 | protocol: all
126 | - destination: 11.0.0.0-169.253.255.255
127 | protocol: all
128 | - destination: 169.255.0.0-172.15.255.255
129 | protocol: all
130 | - destination: 172.32.0.0-192.167.255.255
131 | protocol: all
132 | - destination: 192.169.0.0-255.255.255.255
133 | protocol: all
134 | - name: dns
135 | rules:
136 | - destination: 0.0.0.0/0
137 | ports: '53'
138 | protocol: tcp
139 | - destination: 0.0.0.0/0
140 | ports: '53'
141 | protocol: udp
142 | ```
143 | Modify the default ASGs to block outbound traffic as necessary for your installation. To see how the ASGs are defined by
144 | default, see the [cf-deployment.yml](https://github.com/cloudfoundry/cf-deployment/blob/main/cf-deployment.yml#L604-L627) file on GitHub.
145 | dev_console_1:
146 | dev_console_2: CLI
147 | dev_console_3:
148 | dev_console_4:
149 | dev_console_5:
150 | dev_console_note:
151 | diego_architecture: This topic provides an overview of the structure and components of Diego, the container management system for Cloud Foundry.
152 | diego_deploy: To deploy Diego, see the [Cloud Foundry Diego (BOSH release)](https://github.com/cloudfoundry-incubator/diego-release) repository on GitHub.
153 | diego_ssh_link: Diego SSH package
154 | disable_custom_buildpacks_note: Operators can choose to disable custom buildpacks in an entire deployment. For more information, see the [Disabling Custom Buildpacks](../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic.
155 | disable_custom_buildpacks: You can disable custom buildpacks for an entire deployment by adding disable_custom_buildpacks: true in your Cloud Foundry manifest under `properties.cc`.
156 | disable_custom:
Disabling Custom Buildpacks
Operators can choose to disable custom buildpacks. For more information, see the [Disabling Custom Buildpacks](../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic.
157 | docker_auth: To run Docker containers, Cloud Foundry needs the ability to access Docker registries using a Certificate Authority. To configure this access, see [Installing Certificates on VMs](ttps://bosh.io/docs/trusted-certs.html) in the BOSH documentation.
158 | domain_name: cloudfoundry.org
159 | domains_shared_domains:
160 | ecr_support_cf_12_1:
Note This feature is only available in cf-deployment v12.1.0 and later.
161 | email_notifications:
162 | enable_c2c_discovery: include the [`enable\_service\_discovery`](https://github.com/cloudfoundry/cf-deployment/blob/master/operations/enable-service-discovery.yml) ops file in your Cloud Foundry deployment, as described in [CF App Service Discovery](https://github.com/cloudfoundry/cf-networking-release/blob/develop/docs/05-service-discovery.md) in the cf-networking-release repository on GitHub
163 | enable_syslog_drain: For more information, see [Configuring System Logging](../running/managing-cf/logging-config.html) and [Using Log Management Services](../devguide/services/log-management.html).
164 | enable_syslog_forwarding_link:
Note For this procedure to work, you must enable system log forwarding. For more information, see the Enabling System Log Forwarding section of the Configuring System Logging topic.
Global Auditor: Read-only access to all Cloud Controller API resources except for secrets, such as environment variables. The Global Auditor role cannot access those values. Assigned the cloud_controller.global_auditor scope in UAA.
"
180 | grant_devs_c2c: edit your BOSH manifest to include the `enable_space_developer_self_service` property in the [cf-networking-release policy-server job](https://github.com/cloudfoundry/cf-networking-release/blob/master/jobs/policy-server/spec) and set that property to `true`
181 | health_monitor_footnote: Configuring Health Monitor Notifications
182 | http2_admin_link: For information about configuring support for HTTP/2 in Cloud Foundry, see Configuring HTTP/2 Support.
183 | http2_support_version: In routing-release v0.224.0 and later, HTTP/2 support is enabled by default.
184 | http_routing: For more information, see [Securing Traffic into Cloud Foundry](../adminguide/securing-traffic.html).
185 | healthcheck_duration: The duration of the health check Service Unavailable response is configurable using the manifest property `router.requested_route_registration_interval_in_seconds`, which defaults to 20 seconds.
186 | info_loc: In your Cloud Foundry deployment manifest
187 | ipsec_note:
188 | keepalive: For more information, see [Gorouter Back End Keep-Alive Connections](../adminguide/routing-keepalive.html).
189 | keepalive_router: An operator can enable the feature by configuring a non-zero value for the manifest property `router.max_idle_connections`.
190 | known_issues: Troubleshooting Cloud Foundry
191 | lb_health_chk_healthy: router.drain_wait
192 | lb_health_chk_unhealthy: router.load_balancer_healthy_threshold
193 | link_adminguide_buildpack: For more information, see [Managing Custom Buildpacks](../adminguide/buildpacks.html).
194 | link_adminguide_commands:
195 | link_adminguide_domains: For admin-specific commands, see [Managing Domains and Routes](../../adminguide/manage-domains-routes.html).
196 | link_configure_trusted_certificates: For information about providing trusted certificates to applications running on Cloud Foundry, see [Configuring Trusted System Certificates for Applications](../../running/trusted-system-certificates.html).
197 | log_management:
198 | logg_forwarding: the [Enabling System Log Forwarding](../running/managing-cf/logging-config.html#syslog-forward) section of the _Configuring System Logging_ topic.
199 | logg_scaling: Scaling Loggregator section of the Configuring System Logging topic.
200 | loggregator_arch_link: Loggregator Architecture
201 | loggregator_firehose_link: Loggregator Architecture
202 | loggregator_log_cache_link:
203 | loggregator_log_cache_link_syslog_scale: For guidance on scaling, see the [README](https://github.com/cloudfoundry/cf-syslog-drain-release/blob/master/README.md) for the CF Syslog Drain Release repository on GitHub.
204 | manage_iso_seg_link: For information about how to create and manage isolation segments in a Cloud Foundry deployment, see [Managing Isolation Segments](../adminguide/isolation-segments.html).
205 | manifest_vs_cli_asg: You may also define ASGs in your Cloud Foundry deployment manifest, but these definitions only create security groups during first-time installation. To avoid confusion, any such definitions in the manifest should be generic. The cf CLI commands `create-security-group` and `bind-security-group` overwrite ASG definitions from the manifest. Upgrading Cloud Foundry retains ASG definitions made from the CLI and ignores any ASG definitions in the newer manifest.
206 | max_app_size_table: Set in the cc.packages.max_package_size in the manifest
207 | max_app_size: the maximum app file size set in the cc.packages.max_package_size property in the manifest
208 | max_healthcheck_timeout: cc.maximum_health_check_timeout defaults to the maximum of `180` seconds, but your Cloud Foundry operator can set it to a different value.
209 | max_in_flight_header:
Setting max_in_flight values
210 | max_in_flight_config: For more information, see the [Update Block](https://bosh.io/docs/deployment-manifest.html#update) section of the _Deployment Manifest v1_ topic in the BOSH documentation.
211 | mutual_tls_tcp:
Note If you have mutual TLS app identity verification enabled, you must also enable support for TLS backends with TCP Router via the tcp_router.backend_tls.enabled property, and on Route Emitter via the tcp.enable_tls property..
212 | net_traffic_rules: network traffic rules
213 | notifications_api_1: For more information about the Notifications Service, see the Notifications API [v1](https://github.com/cloudfoundry-incubator/notifications/blob/master/V1_API.md) or [v2](https://github.com/cloudfoundry-incubator/notifications/blob/master/V2_API.md) documentation.
214 | notifications_link: Notification Service
215 | om_resurrector_header:
216 | om_resurrector_text:
217 | or_apps_man2:
218 | per_route_lb_version: Available from cf-deployment v48.1.0, together with CF CLI 8.10.0 and later.
219 | platform_ssh_configuration: Cloud Foundry deployments control SSH access to apps at the Cloud Foundry level. Additionally, Cloud Foundry supports load balancing of SSH sessions. For more information about setting SSH access for your deployment, see [Configuring SSH Access](../../running/config-ssh.html).
220 | pools_link: Building a Manifest in the BOSH documentation.
221 | port_limitations: To support WebSockets, the operator must configure the load balancer correctly. Depending on the configuration, clients may have to use a different port for WebSocket connections, such as port 4443, or a different domain name. For more information, see [Supporting WebSockets](../../adminguide/supporting-websockets.html).
222 | port_limitations_1: To support WebSockets, the operator must configure the load balancer correctly. Depending on the configuration, clients may have to use a different port for WebSocket connections, such as port 4443, or a different domain name. For more information, see [Supporting WebSockets](../adminguide/supporting-websockets.html).
223 | private_app_domain: private-domain.example.com
224 | public_host: docs.cloudfoundry.org
225 | pw_policy:
226 | python_cf245only: Required for Cloud Foundry v245 only:
227 | quota_resource: quota space
228 | recommended_by: Cloud Foundry
229 | resurrector: For more information about the Resurrector, see [Auto-healing Capabilities](https://bosh.io/docs/resurrector.html) in the BOSH documentation.
230 | roles_table: "_oss_roles_table"
231 | rotated_key: encryption_key_2023_02_21
232 | open_service_broker_api: "../open-service-broker/spec"
233 | open_service_broker_api_profile: "../open-service-broker/profile"
234 | open_service_broker_rn: "../open-service-broker/release-notes"
235 | route_services_apps_manager:
236 | route_services_config:
Enabling Route Services in Cloud Foundry
To enable support for route services in a Cloud Foundry deployment, the operator must provide a passphrase used by the Gorouter to encrypt a header that is sent with the request to the route service. The Gorouter uses this header to validate the request sent by the route service to the app route. The passphrase is configured in the cf-release manifest.
Note The route\_services\_secret property should be a robust passphrase. For more information, see the Gorouter spec in the cf-release repository on GitHub.
Route service instances should send requests to the value of x-cf-forwarded-url, obeying the scheme. The scheme is https by default. For environments that do not support TLS termination, this property can be set to false.
The Gorouter only forwards requests to route services over SSL. By default, certificates provided by route services must be signed by a trusted CA. If they are not, the Gorouter rejects the request. In development environments, this concern may be unreasonable. To disable SSL certificate validation, modify the following property:
properties: router: ssl\_skip\_validation: true
237 | route_services_enabling: |-
238 |
Enabling route services in Cloud Foundry
239 |
240 | To begin support for route services in a Cloud Foundry deployment, you
241 | must provide a passphrase used by the Gorouter to encrypt a header that is sent with
242 | the request to the route service.
243 | The Gorouter uses this header to validate the request sent by the route service to the app route.
244 | The passphrase is configured in the cf-release manifest.
245 |
246 | ```console
247 | properties
248 | router:
249 | route_services_secret: YOUR-SECRET-PASSPHRASE
250 | ```
251 |
252 |
The route_services_secret property can
253 | be a robust passphrase.
254 |
255 |
For more information, see the
256 | Gorouter spec
257 | in the cf-release repository on GitHub.
258 |
259 |
260 | Route service instances can send requests to the value of x-cf-forwarded-url, obeying the scheme.
261 | The scheme is https by default.
262 | For environments that do not support TLS termination, this property can be set to false.
263 |
264 | ```
265 | properties:
266 | router:
267 | route_services_recommend_https: true
268 | ```
269 |
270 | The Gorouter only forwards requests to route services over SSL.
271 | By default, certificates provided by route services must be signed by a trusted CA.
272 | If they are not, the Gorouter rejects the request.
273 | In development environments, this concern might be unreasonable.
274 | To deactivate SSL certificate validation, edit the following property:
275 |
276 | ```
277 | properties:
278 | router:
279 | ssl_skip_validation: true
280 | ```
281 | route_services_link: Manage App Requests with Route Services
282 | route_services_require_diego:
Route services require Diego. Your deployment must use the Diego architecture or you must enable Diego for your app.
283 | route_services_securing_traffic: For more information about securing traffic into Cloud Foundry, see [Securing Traffic into Cloud Foundry](../adminguide/securing-traffic.html).
284 | route_services:
Note Route services require Diego. Your deployment must use the Diego architecture or you must enable Diego for your app.
285 | saml_provider: Retrieve the name of your SAML provider by opening your Cloud Foundry manifest and recording the value of the `login.saml.providers.provider-name` property.
286 | scale_table: "oss_scale_table"
287 | scaling_ert_db:
288 | scaling_ert:
289 | self_signed: Before following the procedure below, the developer must obtain either the self-signed certificate or the intermediate and CA certificates used to sign the deployment's certificate. The developer can obtain these certificates from the Cloud Foundry operator or from the deployment manifest. For more information about how to retrieve certificates from the deployment manifest, see [Securing Traffic into Cloud Foundry](../adminguide/securing-traffic.html).
290 | services: services
291 | ssh_marketplace_output: mysql 100mb MySQL databases on demand
292 | ssh_marketplace_step: Run `cf marketplace` to list the marketplace services available.
293 | ssh_service_access_key: { "hostname": "us-cdbr-iron-east-01.mysql.net", "jdbcUrl": "jdbc:mysql://us-cdbr-iron-east-03.mysql.net/ad\_b2fca6t49704585d?user=b5136e448be920\u0026password=231f435o05", "name": "ad\_b2fca6t49704585d", "password": "231f435o05", "port": "3306", "uri": "mysql://b5136e448be920:231f435o05@us-cdbr-iron-east-03.mysql.net:3306/ad\_b2fca6t49704585d?reconnect=true", "username": "b5136e448be920" }
294 | ssh_service_host: us-cdbr-iron-east-01.mysql.net
295 | ssh_service_plan: 100mb
296 | ssh_service: MySQL
297 | ssl:
298 | setting_rate_limit_cloud_api:
299 | starting_container_count_maximum: For information about how to configure this setting, see [Configuring Diego for Upgrades](../running/diego-upgrades.html).
300 | suspended_roles_table: "_suspended_org_roles_table"
301 | syslog_forwarding_ref: Syslog forwarding. See Streaming App Logs to Log Management Services.
302 | tcp_iaas: Configure these IPs as your static IPs in your deployment manifest.
303 | tcp_port_review:
304 | tcp_port: "../adminguide/tcp_modify_ports"
305 | uaa_cli: For more information, see [Creating and Managing Users with the UAA CLI (UAAC)](../../uaa/uaa-user-management.html) and [Orgs, Spaces, Roles, and Permissions](../../concepts/roles.html).
306 | uaa_cred: see the `uaa scim` section
307 | uaa: UAA
308 | understanding_asg_individual_link: the [Create ASGs](https://docs.cloudfoundry.org/concepts/asg.html#asg-individual) section of the _App Security Groups_
309 | upload_custom_buildpacks: You can also use the `cf create-buildpack` command to upload the buildpack into your deployment, making it accessible without the `-b`. Run flag:
cf create-buildpack BUILDPACK PATH POSITION
Where flag:
BUILDPACK specifies the buildpack name.
PATH specifies the location of the buildpack. PATH can point to a ZIP file, the URL of a ZIP file, or a local directory.
POSITION specifies where to place the buildpack in the detection priority list.
310 | user_org_creation:
311 | v3_cli_versions: The experimental commands described in this topic require the cf CLI v6.32.0 or later and a Cloud Foundry deployment with Cloud Controller API v3.27.0 or later.
312 | warden_garden:
313 | zipkin_enable: zipkin_oss_config
314 | zipkin_enable_link:
When Zipkin tracing is enabled in Cloud Foundry, the Gorouter examines the HTTP request headers and performs:
315 | w3c_enable_link:
When W3C tracing is enabled in Cloud Foundry, the Gorouter examines the HTTP request headers and performs:
When the container-to-container networking feature is disabled, all app-to-app traffic must go through the Gorouter.
322 | isolation_segments_create:
323 | install_isolation_segments: For more information about creating isolation segments, see [Managing Isolation Segments](isolation-segments.html).
324 | isolation_segments_note:
Note The isolation segment name used in the cf CLI command must match the value specified in the placement_tags section of the Diego manifest file. If the names do not match, Cloud Foundry fails to place apps in the isolation segment when apps are started or restarted in the space assigned to the isolation segment.
327 | ha_ert:
328 | route_services_appsman1:
329 | route_services_appsman2:
330 | user_provided_apps_man:
331 | xfcc_always_forward: This mode is enabled by default or when `router.forwarded_client_cert: always_forward`.
332 | xfcc_mtls_forward: This mode is enabled when `router.forwarded_client_cert: forward`.
333 | xfcc_strip: This mode is enabled when `router.forwarded_client_cert: sanitize_set`.
334 | gorouter_sni:
The Gorouter supports SNI and can be configured with multiple certificates, each which may optionally include wildcard and alternative names.
335 | multiple_certs_gorouter: To configure multiple HTTPS certificates for Cloud Foundry, specify those certificate keypairs in the `router.tls_pem` property.
336 | uaa_admin_client_creds: Record the **uaa:admin:client_secret** from your deployment manifest.
337 | tcp_emitter_oauth_creds: Obtain the secret for your `tcp_emitter` OAuth client from your manifest.
338 | tcp_app_domain: tcp-domain.example.com
339 | routing_version: routing-release 0.166.0
340 | gorouter_metrics_link: ../running/all_metrics.html#routing
341 | internal_domain_config:
Note Admins can create internal domains. For more information, see the Internal Domains section in the cf-networking-release repository on GitHub.
343 | gorouter_client_cert: "gorouter_client_cert_oss"
344 | ssl_termin_gorouter: "ssl_termin_gorouter_oss"
345 | ssl_termin_lb_only: "ssl_termin_lb_only_oss"
346 | ssl_termin_gorouter_lb: "ssl_termin_gorouter_lb_oss"
347 | grootfs_reserved_space: Alternatively, you can set the GrootFS `reserved_space_for_other_jobs_in_mb` property to a higher value.
348 | grootfs_disk_usage_link: For more information about how to calculate GrootFS disk usage in your deployment, see [Examining GrootFS Disk Usage](../adminguide/examining_grootfs_disk.html).
349 | zdt_enable: Use capi-release v0.168.0 or later and deploy the [cc\_deployment\_updater](https://github.com/cloudfoundry/cf-deployment/blob/master/operations/experimental/add-deployment-updater.yml). For this ops file, there are also [external-db](https://github.com/cloudfoundry/cf-deployment/blob/master/operations/experimental/add-deployment-updater-external-db.yml) and [postgres](https://github.com/cloudfoundry/cf-deployment/blob/master/operations/experimental/add-deployment-updater-postgres.yml) variants.
350 | get_auditor_binary: Download the Stack Auditor binary for your OS from [Releases](https://github.com/cloudfoundry/stack-auditor/releases) in the Stack Auditor repository on GitHub.
351 | droplet_config: system_blobstore_ccdroplet_max_staged_droplets_stored property in the Cloud Foundry manifest.
352 | blobstore_link: Cloud Controller Blobstore Configuration
353 | capi_sidecar_req:
Note This feature requires that your Cloud Foundry deployment uses capi-release 1.790 or later.
354 | enable_docker_link: To enable Docker support, see the [Enable Docker](../../adminguide/docker.html#enable) section of the _Using Docker in Cloud Foundry_ topic.
355 | nozzle_info_link: see [Scaling Nozzles](log-ops-guide.html#scaling-nozzles) in _Loggregator Guide for CF Operators_.
356 | slow_nozzle_alerts_link: For more information, see the [Slow Nozzle Alerts](../../loggregator/log-ops-guide.html#slow-noz) section of the _Loggregator Guide for Cloud Foundry Operators_ topic.
357 | scaling_nozzles_link: For more information, see the [Scaling Nozzles](../../loggregator/log-ops-guide.html#scaling-nozzles) section of the _Loggregator Guide for Cloud Foundry Operators_ topic.
358 | scaling_loggregator_link: For more information, see [Scaling Loggregator](../../loggregator/log-ops-guide.html#scaling) in _Loggregator Guide for Cloud Foundry Operators_.
359 | using_docker_link: For an explanation of how Docker works in Cloud Foundry, see [Using Docker in Cloud Foundry](../../adminguide/docker.html).
360 | cfdev_link: To deploy a local Cloud Foundry environment for experimentation or debugging purposes, you can use CF Dev. For more information, see CF Dev.
361 | zipkin_tracing_link: For more information about Zipkin tracing, see [Enabling Zipkin Tracing](../adminguide/zipkin_tracing.html).
362 | network_policy_quota: The maximum number of policies that a Space Developer can add in a space is set by the `max_policies_per_app_source` property in the `policy-server` job in the Cloud Foundry deployment manifest. By default, the maximum is 150.
363 | network_policy_quota_config: To change the network policy quota for Space Developers, the Cloud Foundry operator must configure the `max_policies_per_app_source` property, then re-deploy Cloud Foundry.
364 | human_readable_timestamp:
365 | find_metric_name_source_id: see [CF Component Metrics](../running/all_metrics.html) and [UAA Performance Metrics](../uaa/uaa-metrics.html)
366 |
--------------------------------------------------------------------------------
/docker/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM ruby:2.6.9-alpine3.15
2 |
3 | ARG DOCS_BOOK_CLOUDFOUNDRY_REPO=https://github.com/cloudfoundry/docs-book-cloudfoundry.git
4 | ARG DOCS_BOOK_CLOUDFOUNDRY_WORKDIR=/tmp/docs-book-cloudfoundry
5 | ARG NODEJS_VERSION=v16.9.1
6 |
7 | WORKDIR $DOCS_BOOK_CLOUDFOUNDRY_WORKDIR
8 | COPY files/Gemfile /tmp/Gemfile
9 |
10 | RUN cd /opt/ && wget https://nodejs.org/dist/$NODEJS_VERSION/node-$NODEJS_VERSION-linux-x64.tar.xz && \
11 | tar -xf /opt/node-$NODEJS_VERSION-linux-x64.tar.xz && ln -s /opt/node-$NODEJS_VERSION-linux-x64/bin/* /usr/bin/ && \
12 | apk add build-base git make g++ && cd /tmp && git clone $DOCS_BOOK_CLOUDFOUNDRY_REPO && \
13 | cd $DOCS_BOOK_CLOUDFOUNDRY_WORKDIR && rm $DOCS_BOOK_CLOUDFOUNDRY_WORKDIR/Gemfile && \
14 | mv /tmp/Gemfile $DOCS_BOOK_CLOUDFOUNDRY_WORKDIR/Gemfile && bundle install && \
15 | rm -rf /opt/node-$NODEJS_VERSION-linux-x64.tar.xz
16 |
17 | EXPOSE 4567
18 |
19 | CMD ["bundle","exec","bookbinder","watch"]
--------------------------------------------------------------------------------
/docker/README.md:
--------------------------------------------------------------------------------
1 | # Ruby 2.6.9 container that includes the functionality to run the Cloudfoundry documentation webserver
2 |
3 | ## Set up the Container and inject the corresponding documentation structure
4 |
5 | You can specify the injected documentation repository as mounted volume under the `/tmp` directory. The following example gives you an overview how you can specify it.
6 | ```yaml
7 | volumes:
8 | - //cf/docs-dev-guide:/tmp/docs-dev-guide
9 | ```
10 |
11 | ## Start the container via the compose file
12 |
13 | You can start the container manually, or you can use the `docker-compose up -d` command to run it in daemon mode and open the documentation inside your browser under `localhost:4567`.
14 |
--------------------------------------------------------------------------------
/docker/docker-compose.yml:
--------------------------------------------------------------------------------
1 | version: "3"
2 | services:
3 | ruby-cf-bookbindery:
4 | image: ruby-cf-bookbindery
5 | container_name: ruby-cf-bookbindery
6 | build: .
7 | network_mode: bridge
8 | ports:
9 | - "4567:4567"
10 | volumes:
11 | - //cf/docs-dev-guide:/tmp/docs-dev-guide
--------------------------------------------------------------------------------
/docker/files/Gemfile:
--------------------------------------------------------------------------------
1 | source 'http://rubygems.org'
2 | gem 'bookbindery', "10.1.18"
3 | gem 'rake'
4 | gem 'jasmine'
5 | gem 'font-awesome-sass', '4.7.0'
6 | gem 'haml', '~> 5.0'
7 | gem 'ffi', '< 1.17.0'
--------------------------------------------------------------------------------
/manifest.yml:
--------------------------------------------------------------------------------
1 | ---
2 | applications:
3 | - name: docs-oss
4 | buildpack: ruby_buildpack
5 | domain: cfapps.io
6 | host: tasks-review-oss
7 | instances: 3
8 | memory: 256M
9 | path: final_app
10 | stack: cflinuxfs2
11 |
--------------------------------------------------------------------------------
/master_middleman/source/404.html.erb:
--------------------------------------------------------------------------------
1 | ---
2 | title: Page not Found
3 | ---
4 |
5 | Visit the homepage.
6 |
7 |
8 |
9 |
10 | Visit the homepage for this topic.
11 |
16 |
--------------------------------------------------------------------------------
/master_middleman/source/contribute.html.md.erb:
--------------------------------------------------------------------------------
1 | ---
2 | title: Contributing Documentation
3 | owner: Docs
4 | ---
5 |
6 | ## Why Should You Contribute?
7 |
8 | The Cloud Foundry documentation relies on contributions from the community to remain accurate, complete, and consumable.
9 |
10 | Reasons to contribute to the Cloud Foundry documentation include:
11 |
12 | * You have noticed that a topic is incorrect or incomplete.
13 | * You are developing a new Cloud Foundry feature, and want to tell users know how to use it.
14 | * You are a good person, and you want to help your fellow humans.
15 | * You hate the idea of someone else having to go through what you just went through to figure something out. Such a waste; so inefficient.
16 |
17 |
18 | ## How Can You Contribute?
19 |
20 | The content for the Cloud Foundry documentation lives in several GitHub repos within the [cloudfoundry GitHub org](https://github.com/cloudfoundry/). Each topic is represented by a source file in Markdown/HTML/embedded Ruby (`html.md.erb`) format.
21 |
22 | You can contribute to the documentation by [submitting a pull request](#pull-request) or [raising an issue](#raise-issue) in GitHub.
23 |
24 | Before contributing, you may want to consult [Best Practices](#best-practices) below for guidance.
25 |
26 | ### Best Practices
27 |
28 | The Cloud Foundry Documentation Team reviews and revises all contributions. As a result, the team recommends that contributors **focus on providing correct and complete information, and not worry about style and structure**.
29 |
30 | If you want to adopt best practices for documentation, keep in mind the following:
31 |
32 | * **Empathize with the newcomer.** Put yourselves in the shoes of a novice and read through your change. Revise the text to answer any questions that might occur to a less experienced user.
33 | * **Consider your audience.** Who needs this information? Are they a developer or an operator?
34 | * **Be specific.** What are the details that a user needs to know in order to understand and perform a task?
35 | * **Provide use-cases**. If you're giving instructions, explain why you would want to follow them. What is the specific use case?
36 |
37 | For further guidance, contact the Cloud Foundry Documentation Team at cf-docs@pivotal.io or through our `#cf-docs` channel on the [Cloud Foundry Slack](https://cloudfoundry.slack.com).
38 |
39 | ### Option 1: Submit a Pull Request
40 |
41 | To contribute to the documentation by submitting a pull request, do the following:
42 |
43 | 1. Navigate to the topic that you want to modify.
44 |
45 | 1. To locate the GitHub source file that contains the content for the topic, scroll to the bottom of the page and click **Create a pull request or raise an issue on the source for this page in GitHub.**
46 |
47 | 1. Click the pencil icon in the upper right to edit the file in GitHub.
48 |
49 | 1. Make your desired changes.
50 |
51 | 1. Under **Commit changes** at the bottom of the page, enter a description of your change and click **Propose file change**.
52 |
53 | 1. Click **Create pull request**.
54 |
55 | ### Option 2: Raise an Issue
56 |
57 | If you have identified a problem with the documentation, but do not know the required content change, file a GitHub issue against the repo that contains the content.
58 |
59 | To create an issue on a GitHub repo, do the following:
60 |
61 | 1. Navigate to the topic that you want to modify.
62 |
63 | 1. To locate the GitHub source file that contains the content for the topic, scroll to the bottom of the page and click **Create a pull request or raise an issue on the source for this page in GitHub.**
64 |
65 | 1. Click the name of the repo where the topic is located. For example, `docs-deploying-cf`.
66 |
67 | 1. Click the **Issues** tab.
68 |
69 | 1. Click **New issue**.
70 |
71 | 1. Enter a title for your issue, and in the text box, describe the issue and provide links to the affected topic(s).
72 |
73 | 1. Click **Submit new issue**.
74 |
75 |
76 | ## How Can You Preview Your Documentation Changes?
77 |
78 | The Cloud Foundry Documentation Team uses the tool [Bookbinder](https://github.com/pivotal-cf/bookbinder) to publish the Cloud Foundry documentation.
79 |
80 | The instructions below explain how to use Bookbinder to preview your documentation changes locally. But you do not have to install or use Bookbinder in order to contribute to the Cloud Foundry documentation.
81 |
82 | To preview documentation changes with Bookbinder, do the following:
83 |
84 | 1. If you do not already have a workspace directory within your home directory, create one.
85 |
$ mkdir ~/workspace
86 |
87 | 1. Clone the layout repo. This contains layouts, formatting, and styles used across all documentation sets.
88 |
89 |
90 | 1. Identify the content repo where your documentation lives. For example, `https://github.com/cloudfoundry/docs-cloudfoundry-concepts`.
91 |
92 | 1. Clone the content repo. For example:
93 |
97 |
98 | 1. Change directory into the Cloud Foundry book.
99 |
cd docs-book-cloudfoundry
100 |
101 | 1. Run `bundle install` to install the necessary gems, including Bookbinder.
102 |
103 | 1. Use Bookbinder to create a live version of your docs:
104 |
$ bundle exec bookbinder watch
105 |
106 | 1. Navigate to `http://localhost:4567` in a browser and navigate to the route where your docs are published. For instance, `http://localhost:4567/cf-cli/install-go-cli.html`.
107 |
Cloud Foundry is an open-source platform as a service (PaaS) that provides you with a
11 | choice of clouds, developer frameworks, and application services.
12 |
8 |
--------------------------------------------------------------------------------
/master_middleman/source/layouts/_pre-content.erb:
--------------------------------------------------------------------------------
1 | <%# Unless you've set `modified_date` to false in the frontmatter, add the `modified_date` variable to the beginning of a topic. %>
2 | <% unless current_page.data.modified_date == false %>
3 |
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Necessitatibus totam libero facilis voluptatem aliquam incidunt ipsa officiis, dicta nihil expedita, molestiae delectus impedit hic quidem deserunt laudantium, sint debitis tenetur.
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Necessitatibus totam libero facilis voluptatem aliquam incidunt ipsa officiis, dicta nihil expedita, molestiae delectus impedit hic quidem deserunt laudantium, sint debitis tenetur.
10 |