Skip to content

Commit a4c4a0f

Browse files
committed
variable-ize platform product name [#168015936]
1 parent 4cea3bf commit a4c4a0f

32 files changed

+210
-213
lines changed

bosh-release.html.md.erb

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ owner: Services
66
<strong><%= modified_date %></strong>
77

88
This topic provides resources for creating a BOSH release that integrates a
9-
software service with Pivotal Cloud Foundry (PCF) at the managed service level.
9+
software service with <%= vars.product_name %> at the managed service level.
1010

1111
## <a id="overview"></a> Overview
1212

@@ -18,7 +18,7 @@ manifest containing configuration and deployment properties.
1818

1919
The BOSH manifest specifies the following major components:
2020

21-
- **Packages** that can be installed on PCF stemcells to create VM
21+
- **Packages** that can be installed on <%= vars.product_name %> stemcells to create VM
2222
images
2323

2424
- **Jobs** that describe how to install, run, and remove your software
@@ -58,17 +58,17 @@ These topics explain how to create a BOSH release:
5858
If you have already packaged your service as Docker images, you can emulate
5959
a managed service deployment using the [Tile Generator](tile-generator.html)'s
6060
support for `docker-bosh` packages. This feature lets you deploy pre-existing
61-
Docker images into BOSH-managed VMs on the PCF infrastructure.
61+
Docker images into BOSH-managed VMs on the <%= vars.product_name %> infrastructure.
6262

63-
While this is a great, easy way to deploy your service on PCF, we do not
63+
While this is a great, easy way to deploy your service on <%= vars.product_name %>, we do not
6464
recommend this as a long-term, production-ready solution. There is really no
6565
benefit of running your service in containers on the VMs, and it does have
6666
a number of operational ("day 2") drawbacks:
6767

6868
- You introduce more software (Docker) which needs to be kept up-to-date, and
6969
has the potential for issues, downtime, and security vulnerabilities.
7070

71-
- You can no longer take advantage of the patching capabilities of PCF for
71+
- You can no longer take advantage of the patching capabilities of <%= vars.product_name %> for
7272
stemcells and application dependencies, such as frameworks and libraries. Instead,
7373
you become directly responsible for managing all software that is in the Docker
7474
images you deploy.

brokered.html.md.erb

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,32 +5,32 @@ owner: Services
55

66
<strong><%= modified_date %></strong>
77

8-
The topics in this subsection explain how to integrate your software service with Pivotal Cloud Foundry (PCF) to create a brokered service and service tile for PCF.
8+
The topics in this subsection explain how to integrate your software service with <%= vars.product_name %> to create a brokered service and service tile for <%= vars.product_name %>.
99

1010
## <a id="overview"></a> Overview
1111

12-
You can achieve the first real improvement in your PCF customers user experience by creating a [Service Broker](service-brokers.html) for your service.
12+
You can achieve the first real improvement in your <%= vars.product_name %> customers user experience by creating a [Service Broker](service-brokers.html) for your service.
1313

14-
A brokered service runs external to PCF, but it has a tile on [Pivotal Network](http://network.pivotal.io) (PivNet). Operators install, configure, and upgrade the tile through the Ops Manager Installation Dashboard.
14+
A brokered service runs external to <%= vars.product_name %>, but it has a tile on [Pivotal Network](http://network.pivotal.io) (PivNet). Operators install, configure, and upgrade the tile through the Ops Manager Installation Dashboard.
1515

1616
The service broker eliminates the need for your customers to know the URLs and
1717
credentials for your services; they are managed automatically by the
1818
broker.
1919

2020
Building a broker for a (still) externally deployed service is generally
21-
a good way to publish a first tile that adds real value for customers who have both your software and PCF.
21+
a good way to publish a first tile that adds real value for customers who have both your software and <%= vars.product_name %>.
2222

2323
## <a id="create"></a> Create a Brokered Service
2424

2525
* A brokered service requires a service broker, which publishes an API to the Cloud Controller.
2626
[Service Brokers](./service-brokers.html) explains how to create one.
2727

28-
* [Route Services](./service-brokers.html#route) explains how to create a route service, for use in the routing layer of PCF rather than by hosted PCF apps.
28+
* [Route Services](./service-brokers.html#route) explains how to create a route service, for use in the routing layer of <%= vars.product_name %> rather than by hosted <%= vars.product_name %> apps.
2929

3030
* [Catalog](./service-brokers.html#catalog) explains how to design the part of your service broker API that publishes service plan information to the Services Marketplace.
3131

3232
* You can write your service broker in the language of your choice.
33-
[Buildpacks](./buildpacks.html) explains how to create a language-specific buildpack that compiles and packages your service broker to run on PCF.
33+
[Buildpacks](./buildpacks.html) explains how to create a language-specific buildpack that compiles and packages your service broker to run on <%= vars.product_name %>.
3434

3535
* Once you have the individual components for your brokered service integration, you can work through [Building Your First Tile](./index.html#tile-steps) to create your tile.
3636

buildpacks.html.md.erb

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ owner: Services
55

66
<strong><%= modified_date %></strong>
77

8-
Buildpacks compile and package apps to run on Pivotal Cloud Foundry (PCF). This topic lists resources for using and deploying buildpacks with PCF apps, and for creating your own custom buildpack.
8+
Buildpacks compile and package apps to run on <%= vars.product_name %>. This topic lists resources for using and deploying buildpacks with <%= vars.product_name %> apps, and for creating your own custom buildpack.
99

1010
## <a id="language"></a> Official Buildpacks
1111

@@ -30,7 +30,7 @@ Buildpacks compile and package apps to run on Pivotal Cloud Foundry (PCF). This
3030
Buildpacks can also be used to inject additional code into the application container.
3131
For more information, see the following:
3232

33-
- The PCF documentation topic [Creating Custom Buildpacks](https://docs.pivotal.io/pivotalcf/buildpacks/custom.html)
33+
- The <%= vars.product_name %> documentation topic [Creating Custom Buildpacks](https://docs.pivotal.io/pivotalcf/buildpacks/custom.html)
3434

3535
- The github repo [Eureka Registrar Sidecar](https://github.com/cf-platform-eng/eureka-registrar-sidecar)
3636

cf-concepts.html.md.erb

+11-11
Original file line numberDiff line numberDiff line change
@@ -7,46 +7,46 @@ owner: Services
77

88
<strong><%= modified_date %></strong>
99

10-
There are many ways to integrate services with Pivotal Cloud Foundry (PCF). The right one for each service depends on what the service does, and how
10+
There are many ways to integrate services with <%= vars.product_name %>. The right one for each service depends on what the service does, and how
1111
customer applications consume it. To determine the best way to integrate your
12-
service, you'll need a good understanding of PCF concepts like applications, containers, services, brokers, and buildpacks.
12+
service, you'll need a good understanding of <%= vars.product_name %> concepts like applications, containers, services, brokers, and buildpacks.
1313

1414
This page provides a collection of links to documentation for the most relevant
1515
concepts. If you prefer to learn through guided training,
1616
[ask us](mailto:[email protected]) about available training options.
1717

1818
## <a id="overview"></a>General Overview
1919

20-
For general overview of PCF, and the various ways to interact with it,
20+
For general overview of <%= vars.product_name %>, and the various ways to interact with it,
2121
use the following links:
2222

23-
- [Cloud Foundry Subsystems](http://docs.pivotal.io/pivotalcf/concepts/overview.html) provides high-level descriptions of internal functions performed by different PCF components.
24-
- [Cloud Foundry Command Line Interface (cf CLI)](http://docs.pivotal.io/pivotalcf/cf-cli/index.html) links to topics that explain how to direct PCF deployment from your local command line.
23+
- [Cloud Foundry Subsystems](http://docs.pivotal.io/pivotalcf/concepts/overview.html) provides high-level descriptions of internal functions performed by different <%= vars.product_name %> components.
24+
- [Cloud Foundry Command Line Interface (cf CLI)](http://docs.pivotal.io/pivotalcf/cf-cli/index.html) links to topics that explain how to direct <%= vars.product_name %> deployment from your local command line.
2525
- [Pivotal Ops Manager](http://docs.pivotal.io/pivotalcf/customizing/pcf-interface.html) describes the Ops Manager and Installation Dashboard interfaces, where cloud operators see, install, configure, and deploy service tiles.
2626
- [Pivotal Apps Manager](http://docs.pivotal.io/pivotalcf/console/index.html) describes the Apps Manager interface, where app developers create and configure service instances and bind them to their apps.
2727

2828
## <a id="applications"></a> Applications
2929

3030
Cloud Foundry is primarily a cloud native application platform. To understand how to integrate your services with Cloud Foundry, you should understand how your customers are using the platform to develop, deploy, and operate their applications.
3131

32-
- [Developer Guide](http://docs.pivotal.io/pivotalcf/devguide/index.html) explains how to push an app to run on PCF and enable it to use services.
33-
- [Logging and Monitoring](http://docs.pivotal.io/pivotalcf/loggregator/index.html) describes how PCF aggregates and streams logs and metrics from the apps it hosts and from internal system components.
32+
- [Developer Guide](http://docs.pivotal.io/pivotalcf/devguide/index.html) explains how to push an app to run on <%= vars.product_name %> and enable it to use services.
33+
- [Logging and Monitoring](http://docs.pivotal.io/pivotalcf/loggregator/index.html) describes how <%= vars.product_name %> aggregates and streams logs and metrics from the apps it hosts and from internal system components.
3434

3535
## <a id="services"></a> Services
3636

3737
Most value-add integrations are done by exposing your software to customer applications as services. To understand the service concepts, and what a service integration looks like, read the following documentation:
3838

3939
- [Services Overview](http://docs.pivotal.io/pivotalcf/devguide/services/index.html) explains how developers provision and use existing services in their apps.
40-
- [Cloud Foundry Service Brokers and PCF Tiles](http://docs.pivotal.io/on-demand-service-broker/about.html#cf-broker) briefly describes the two main elements of PCF service integration: the service broker API, which connects the service to PCF internally by taking commands from the Cloud Controller; and the tile, a packaged interface that cloud operators use to install and configure a service within PCF.
41-
- [Custom Services](http://docs.pivotal.io/pivotalcf/services/index.html) explains how service authors package their service as a [Managed Service](./managed.html) that is available for use by PCF operators and developers, and which runs locally on PCF rather than running remotely.
40+
- [Cloud Foundry Service Brokers and <%= vars.product_name %> Tiles](http://docs.pivotal.io/on-demand-service-broker/about.html#cf-broker) briefly describes the two main elements of <%= vars.product_name %> service integration: the service broker API, which connects the service to <%= vars.product_name %> internally by taking commands from the Cloud Controller; and the tile, a packaged interface that cloud operators use to install and configure a service within <%= vars.product_name %>.
41+
- [Custom Services](http://docs.pivotal.io/pivotalcf/services/index.html) explains how service authors package their service as a [Managed Service](./managed.html) that is available for use by <%= vars.product_name %> operators and developers, and which runs locally on <%= vars.product_name %> rather than running remotely.
4242

4343
## <a id="buildpacks"></a> Buildpacks
4444

4545
When application code is deployed to Cloud Foundry, it is processed by a language-specific buildpack. Language buildpacks provide a convenient integration hook for any service that needs to inspect or embellish application code.
4646
Supplying buildpacks also provides a language-agnostic way to inject your code into the application container image.
4747

48-
- [Application Staging Process](http://docs.pivotal.io/pivotalcf/concepts/how-applications-are-staged.html) explains how PCF packages and deploys apps in containers with buildpacks so that they can run on multiple VMs interchangeably.
49-
- [Language Buildpacks](http://docs.pivotal.io/pivotalcf/buildpacks/index.html) describes the language-specific buildpacks support PCF apps.
48+
- [Application Staging Process](http://docs.pivotal.io/pivotalcf/concepts/how-applications-are-staged.html) explains how <%= vars.product_name %> packages and deploys apps in containers with buildpacks so that they can run on multiple VMs interchangeably.
49+
- [Language Buildpacks](http://docs.pivotal.io/pivotalcf/buildpacks/index.html) describes the language-specific buildpacks support <%= vars.product_name %> apps.
5050
- [Custom Buildpacks](https://docs.pivotal.io/pivotalcf/buildpacks/custom.html) describes how to use supply buildpacks to add dependencies or code without having to change (multiple) language-sepcific buildpacks.
5151

5252
## <a id="agents"></a> Embedded Agents

concourse.html.md.erb

+13-13
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ There are two ways to do CI testing on your tile:
2020
## <a id="dashboard"></a>Use Tile Dashboard CI to Test Your Tile
2121

2222
With your tile in our Tile Dashboard CI testing system, we all win.
23-
You stay on top of changes to PCF that may require changes in your tile.
24-
Our field representatives gain a clear understanding of your tile’s compatibility across PCF versions,
23+
You stay on top of changes to <%= vars.product_name %> that may require changes in your tile.
24+
Our field representatives gain a clear understanding of your tile’s compatibility across <%= vars.product_name %> versions,
2525
underlying IaaS, and different flavors of environments.
26-
This also relieves you from maintaining your own CI system, keeping up with latest PCF versions, etc.
26+
This also relieves you from maintaining your own CI system, keeping up with latest <%= vars.product_name %> versions, etc.
2727

2828
The Tile Dashboard CI is part of our Enterprise Readiness criteria
2929
which is used to inform the field of the quality and capabilities of your tile,
@@ -42,7 +42,7 @@ The Tile Dashboard CI runs your tile through a series of steps, which include:
4242
- Use of properties whose values/meanings have changed.
4343
- Use of features that are no longer supported.
4444

45-
3. Configuring, installing, testing, and uninstalling your tile in several PCF environments:
45+
3. Configuring, installing, testing, and uninstalling your tile in several <%= vars.product_name %> environments:
4646
- A patch release of every supported Pivotal Application Service minor version.
4747
- Every supported IaaS
4848
- Environments with extra configuration, such as multiple availability zones and IPsec
@@ -232,7 +232,7 @@ contact us on [Pivotal Partners Slack](https://pivotalpartners.slack.com/).
232232

233233
### <a id="backing"></a> About Backing Services
234234

235-
Your tile might require a backing service outside of the existing PCF environment,
235+
Your tile might require a backing service outside of the existing <%= vars.product_name %> environment,
236236
for example, your tile might be a service broker to a SaaS offering.
237237

238238
You are responsible for maintaining the backing service in an environment
@@ -245,7 +245,7 @@ uses the CI tool [Concourse](http://concourse.ci/) to make sure that partner pro
245245
to work with every new release of the platform.
246246

247247
With more effort, you can also follow the pointers below to set up your own Concourse CI pipeline
248-
that integrates and tests your tile on your own deployment of the latest PCF.
248+
that integrates and tests your tile on your own deployment of the latest <%= vars.product_name %>.
249249

250250
While you are of course also free to use any other CI system you are familiar with,
251251
Pivotal's tools and documentation are built to make Concourse CI as easy as possible.
@@ -266,22 +266,22 @@ see the instructions [Concourse: Setup & Operations](https://concourse-ci.org/se
266266
A typical CI pipeline for a tile consists of the following jobs:
267267

268268
- Build the tile
269-
- Deploy it to PCF
269+
- Deploy it to <%= vars.product_name %>
270270
- Run a set of deployment tests to verify that it deployed and works correctly
271-
- Remove it from PCF
271+
- Remove it from <%= vars.product_name %>
272272

273273
You describe this pipeline in a `pipeline.yml` file that is then uploaded to the
274274
Concourse server. [Tile Generator](tile-generator.html) contains a sample
275275
pipeline that you can clone for your own tile. We are working on automating
276276
the process of generating a pipeline template for you.
277277

278-
### <a id="pool"></a> Set Up PCF for Your CI Pipeline
278+
### <a id="pool"></a> Set Up <%= vars.product_name %> for Your CI Pipeline
279279

280-
Pivotal partners who have us host their pipeline have access to a pool of PCF
280+
Pivotal partners who have us host their pipeline have access to a pool of <%= vars.product_name %>
281281
instances that are managed by us and are regularly updated with the latest
282-
(pre-)release versions of PCF. If you set up your own concourse server, you
283-
have to target your pipeline at a [PCF instance you have setup](./environments.html).
282+
(pre-)release versions of <%= vars.product_name %>. If you set up your own concourse server, you
283+
have to target your pipeline at a [<%= vars.product_name %> instance you have setup](./environments.html).
284284

285285
Concourse has a resource type to manage a pool of resources that are shared
286-
between pipelines, which is what we use to serialize PCF access between the
286+
between pipelines, which is what we use to serialize <%= vars.product_name %> access between the
287287
partner pipelines that run on our concourse server.

credhub.html.md.erb

+6-6
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Both BOSH CredHub and runtime CredHub are instances of the CredHub credential ma
1616

1717
Many <%= vars.product_name %> components use credentials to authenticate connections, and <%= vars.product_name %> installations often have hundreds of active credentials. Secure credential management is essential to prevent data and security breaches.
1818

19-
In Pivotal Cloud Foundry (PCF) v1.11.0, CredHub runs on the BOSH VM, alongside the BOSH Director and UAA. Ops Manager v1.11 stores its credentials in CredHub,
19+
In <%= vars.product_name %> v1.11.0, CredHub runs on the BOSH VM, alongside the BOSH Director and UAA. Ops Manager v1.11 stores its credentials in CredHub,
2020
and users can retrieve them using the CredHub API or the **Credentials** tab of the BOSH Director tile.
21-
Tile developers can embed CredHub calls in [manifest snippets](#snippets) and PCF apps can retrieve credentials using the CredHub API.
21+
Tile developers can embed CredHub calls in [manifest snippets](#snippets) and <%= vars.product_name %> apps can retrieve credentials using the CredHub API.
2222

2323
See [Fetching Variable Names and Values](./get-credhub-vars.html) for how to fetch variable names and values using the CredHub API.
2424

@@ -72,17 +72,17 @@ Tile developers can embed CredHub in product template and job template manifest
7272
password: ((( credhub-password )))
7373
```
7474

75-
## <a id="limitations"></a> PCF v1.11.0 Limitations
75+
## <a id="limitations"></a> <%= vars.product_name %> Limitations
7676

77-
PCF v1.11.0 supports CredHub for credential storage, but it does not support the following:
77+
<%= vars.product_name %> supports CredHub for credential storage, but it does not support the following:
7878

79-
* Automatic backup and restore for CredHub, along with other PCF system components.
79+
* Automatic backup and restore for CredHub, along with other <%= vars.product_name %> system components.
8080

8181
* Automatic tile [upgrades](./tile-upgrades.html) that migrate all types of credentials defined in [property blueprints](./property-template-references.html#property-blueprints) in previous tile versions, to storage in CredHub.
8282

8383
* Using CredHub to generate new credentials.
8484

85-
Tile authors may choose to wait until PCF supports some or all of these features before incorporating CredHub into their service.
85+
Tile authors may choose to wait until <%= vars.product_name %> supports some or all of these features before incorporating CredHub into their service.
8686

8787
## <a id="resources"></a> CredHub Resources
8888

0 commit comments

Comments
 (0)