You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: get-credhub-vars.html.md.erb
+34-27
Original file line number
Diff line number
Diff line change
@@ -3,25 +3,29 @@ title: Fetching variable names and values with CredHub for your services
3
3
owner: CredHub
4
4
---
5
5
6
-
## <aid="overview"></a> CredHub Process overview
7
-
8
-
CredHub has two API endpoints to identify and re-use variables. Operators who want to see all the credentials associated with their product, or support engineers who want to troubleshoot problems specific to one virtual machine (VM), can use these APIs for those purposes.
6
+
CredHub has two API endpoints to identify and reuse variables. To see all the credentials
7
+
associated with your product, or you want to troubleshoot problems specific to one virtual machine (VM),
8
+
you can use these APIs for those purposes.
9
9
10
10
The API endpoints perform these functions:
11
11
12
-
* Identifying and printing the name of a variable
13
-
* Using the name of the variable to identify and print the value of the variable
12
+
* Identifying and printing the name of a variable.
13
+
* Using the name of the variable to identify and print the value of the variable.
14
14
15
15
### <aid="use-api-endpoints"></a> Using the API endpoints
16
16
17
-
Use these endpoints to view variables for any product in Ops Manager, except the BOSH Director. These endpoints are read-only. You cannot use them to add, remove, or rotate variables.
17
+
You can Use endpoints to view variables for any product in Ops Manager, except the BOSH Director. These
18
+
endpoints are read-only. You
19
+
cannot use them to add, remove, or rotate variables.
18
20
19
21
## <aid="fetch-variables"></a> Fetching variables
20
22
21
-
This endpoint returns the list of variables associated with a product that are stored in CredHub. Not all variables are stored in CredHub. If you call a variable that is not stored in CredHub, the call returns an empty value.
23
+
This endpoint returns the list of variables associated with a product that are stored in
24
+
CredHub. Not all variables are stored in
25
+
CredHub. If you call a variable that is not stored in CredHub, the call returns an empty value.
This endpoint returns the value of a variable stored in CredHub. Not all variables are stored in CredHub, so if you call a variable that isn't in CredHub, the call returns an empty value.
59
+
This endpoint returns the value of a variable stored in
60
+
CredHub. Not all variables are stored in CredHub, because if you call a
61
+
variable that is not in CredHub, the call returns an empty value.
Here is information for VMware Tanzu Partners to learn the building and publishing process an Ops Manager tile on [VMware Tanzu Network](https://network.pivotal.io/).
6
+
You can use the following VMware Tanzu Partners information to learn how to build and publish processes for an
7
+
Ops Manager tile on [VMware Tanzu Network](https://network.pivotal.io/).
7
8
8
-
For advanced developers with previous experience building tiles, see [Property and Template References](./property-template-references.html) and [Development Workflow Reference](./dev-workflow.html).
9
+
For advanced developers with previous experience building tiles, see [Property and template references](./property-template-references.html) and [Development workflow reference](./dev-workflow.html).
9
10
10
11
## <aid="tile-def"></a> What is a tile?
11
-
You can integrate tile software into <%=vars.platform_name%>. Operators can install tiles on <%=vars.platform_name%>. Developers can use these services after they are installed.
12
+
You can integrate tile software into <%=vars.platform_name%>. You can install tiles on
13
+
<%=vars.platform_name%>. Developers can use these services after they are installed.
12
14
13
15
Tile developers can publish tiles on VMware Tanzu Network, where services and tiles are available for download.
14
16
@@ -40,20 +42,24 @@ When you package your software with Tile Generator, it generates these subdirect
40
42
41
43
## <aid="tile-value"></a> Why build a tile?
42
44
43
-
There are multiple reasons to build and publish a tile on VMware Tanzu Network. Tiles can help you:
45
+
There are multiple reasons to build and publish a tile on VMware Tanzu Network.
46
+
47
+
Tiles can help you:
44
48
45
49
* Find the widest possible audience for your service.
46
50
* Join a expanding ecosystem that can integrate your service.
47
51
* Operators and app developers can interact with your service in an accessible and standardized way.
48
52
49
53
## <aid="tile-steps"></a> Building your first tile
50
-
Creating a tile is a complex process. You can message the VMware Tanzu Partners Slack channel with questions if you [register for the VMware Tanzu Partner program](https://pivotal.io/partners/programs/tech).
54
+
Creating a tile is a complex process. You can message the VMware Tanzu Partners Slack channel with
55
+
questions if you [register for the VMware Tanzu Partner program](https://tanzu.vmware.com/partners/tech).
51
56
52
57
### <aid="tools"></a> Step 1: Decide what to build
53
58
54
-
If you use Tile Generator to package your software, you must verify the inputs you must build before development. Inputs for your tile also depend on the service you are providing.
59
+
If you use the Tile Generator to package your software, you must verify the inputs you must build before
60
+
development. Inputs for your tile also depend on the service you are providing.
55
61
56
-
Before starting tile development, see [How <%=vars.app_runtime_abbr%> and <%=vars.platform_name%>Services Work](./cf-concepts.html).
62
+
Before you start tile development, see [How <%=vars.app_runtime_abbr%> and <%=vars.platform_name%>services work](./cf-concepts.html).
57
63
58
64
Depending on what you build, you must install the following tools:
59
65
@@ -69,27 +75,34 @@ Depending on what you build, you must install the following tools:
69
75
70
76
#### <a id="generate"></a> Step 2: Generate a tile
71
77
72
-
Tile Generator simplifies building tiles. To use Tile Generator, upload your software components, such as the service broker, buildpack, and Docker image, and the tool generates a base tile.
78
+
Tile Generator simplifies building tiles. To use the Tile Generator, upload your software components,
79
+
such as the service broker, buildpack, and Docker image, and then the tool generates a base tile.
73
80
74
-
For information about setting up Tile Generator and building a base tile, see [Tile Generator](./tile-generator.html).
81
+
For information about setting up the Tile Generator and building a base tile, see [Tile Generator](./tile-generator.html).
75
82
76
83
#### <aid="test"></a> Step 3: Test your tile
77
84
78
-
Before you publish your tile, you can test it manually using a Partner Integration Environment (PIE). In PIE you can see how the tile functions on an IaaS, such as Amazon Web Services (AWS) or Google Cloud Platform (GCP). You can upload, configure, and install your tile in PIE as an operator does.
85
+
Before you publish your tile, you can test it manually using a Partner Integration Environment (PIE). In PIE you can see how the tile functions
86
+
on an IaaS, for example, Amazon Web Services (AWS) or Google Cloud Platform (GCP). You can upload, configure, and
87
+
install your tile in PIE as an operator does.
79
88
80
-
To gain access to your PIE, reach out to your contact at <%=vars.company_name%> or [register as a partner](https://partners.pivotal.io/).
89
+
To gain access to your PIE, reach out to your contact at <%=vars.company_name%> or
90
+
[register as a partner](https://tanzu.vmware.com/partners/tech).
81
91
82
-
If you already have access to your PIE, for information information about how to log in, see [Development Environments](./environments.html).
92
+
If you already have access to your PIE, for information about how to log in, see [Development Environments](./environments.html).
83
93
84
94
#### <aid="document"></a> Step 4: Document your tile
85
95
86
-
When you are ready to publish your tile, write documentation. Documentation is valuable for operators who use your tile.
96
+
When you are ready to publish your tile, write documentation. Documentation is valuable for operators
97
+
who use your tile.
87
98
88
99
For more information about how to write and publish documentation for your tile, see [Tile Documentation](./tile-documentation.html).
89
100
90
101
#### <aid="publish"></a> Step 5: Publish your tile on VMware Tanzu Network
91
102
92
-
Contact your <%=vars.company_name%> representative to guide you through uploading your tile to VMware Tanzu Network. When you upload your tile to the VMware Tanzu Network, it becomes available for operators and developers.
103
+
Contact your <%=vars.company_name%> representative to guide you through uploading your
104
+
tile to VMware Tanzu Network. When you upload your tile to the VMware Tanzu Network, it becomes available for
Copy file name to clipboardexpand all lines: managed-index.html.md.erb
+2-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,8 @@ title: Integrating your managed services
3
3
owner: Services
4
4
---
5
5
6
-
Here is how to integrate your [brokered service](./brokered.html) more closely with <%= vars.platform_name %> to create a managed service and service tile for VMware Tanzu.
6
+
Here is information on how to integrate your [brokered service](./brokered.html) more closely with <%= vars.platform_name %> to
7
+
create a managed service and service tile for VMware Tanzu.
Copy file name to clipboardexpand all lines: managed.html.md.erb
+26-16
Original file line number
Diff line number
Diff line change
@@ -3,28 +3,31 @@ title: How to integrate your managed services
3
3
owner: Services
4
4
---
5
5
6
-
Here is how to integrate your [brokered service](./brokered.html) more closely with <%= vars.platform_name %> to create a managed service and service tile for VMware Tanzu.
7
-
8
-
## <aid="overview"></a> Managed services overview
6
+
You can integrate your [brokered service](./brokered.html) more closely
7
+
with <%= vars.platform_name %> to create a managed service and service tile for VMware Tanzu.
9
8
10
9
The next level of integration is to get your service to be deployed on <%= vars.platform_name %> rather
11
10
than externally, on the same IaaS that your particular Cloud Foundry instance
12
11
is deployed on, and by the same orchestration tool, [BOSH](http://bosh.io).
13
12
14
-
This is usually one of the more involved integrations, as you configure your packaging to allow your service components to be deployed by [BOSH](http://bosh.io) onto the <%=vars.platform_name%> infrastructure.
13
+
This is usually one of the more involved integrations, because you configure your packaging to allow your
14
+
service components to deploy BOSH onto the
15
+
<%= vars.platform_name %> infrastructure.
15
16
16
-
Offering your software as a managed service means that your <%=vars.platform_name%> customers
17
-
can not have to learn different ways to deploy, manage, and monitor
18
-
different components of their application platform.
17
+
When you offer your software as a managed service, it means that you do not have to learn different ways to
18
+
deploy, manage, and monitor different components of your application platform.
19
19
20
-
As with the brokered service, the service has a service broker and a tile listed on VMware Tanzu Network. VMware Tanzu Network lists managed services as "for VMware Tanzu," without "Service Broker" in the name.
20
+
As with the brokered service, the service has a service broker and a tile listed on
21
+
VMware Tanzu Network. VMware Tanzu Network lists managed services as "for VMware Tanzu," without
22
+
"Service Broker" in the name.
21
23
22
-
To integrate your service at this level, you configure to learn about stemcells, BOSH releases, and manifests. You can decide how your service maps to virtual machines and how persistent storage is managed.
24
+
To integrate your service at this level, you learn about stemcells, BOSH releases, and manifests. You can
25
+
decide how your service maps to a virtual machine and how persistent storage is managed.
Minimal Viable Product (MVP) version of a managed service be a single, shared service instance, and don't yet
27
-
worry too much about high availability of this instance. This integration level is mostly about getting the BOSH packaging, deployment, and monitoring working
29
+
Minimal Viable Product (MVP) version of a managed service is a single, shared service instance.
30
+
This integration level is mostly about getting the BOSH packaging, deployment, and monitoring working
28
31
correctly.
29
32
30
33
### <aid="managed-ha"></a> High availability
@@ -34,17 +37,24 @@ After you have a managed service, you can decide to prioritize either
34
37
single shared service instance more highly available.
35
38
36
39
When properly configured, BOSH monitors and restarts any failing processes
37
-
and virtual machines that are part of your service deployment. To further increase availability, consider spreading your
38
-
resources across multiple availability zones or even regions, and replicating
40
+
and VMs that are part of your service deployment. To further increase
41
+
availability, consider spreading your
42
+
resources across multiple AZs or even regions, and replicating
39
43
your persistent storage across those as well.
40
44
41
45
## <aid="create"></a> Create a managed service
42
46
43
47
* For BOSH to manage your service, you must create a BOSH release for it.
44
-
[BOSH releases](./bosh-release.html) explains how to do this, and how to use your already-existing Docker image as a shortcut.
48
+
[BOSH releases](./bosh-release.html) explains how to do this, and how to use your alreadyexisting Docker image as a shortcut.
45
49
46
-
* After you created a BOSH release for your managed service integration, you can work through [Building your first tile](./index.html#tile-steps) to create your tile.
50
+
* After you create a BOSH release for your managed service integration, you can work through
51
+
[Building your first tile](./index.html#tile-steps) to create your tile.
47
52
48
-
* The [Tile generator](./tile-generator.html) tool automatically creates the life cycle errands that can run after a <%=vars.platform_name%> tile is deployed or before it is removed. Operators control which errands run the next time they click **Apply Changes** to redeploy. See the [Errands](./tile-errands.html) topic for how <%=vars.platform_name%> operators control when errands run, and how to set default errand run rules in the tile.
53
+
* The [Tile generator](./tile-generator.html) tool automatically creates the life cycle
54
+
errands that can run after a <%=vars.platform_name%> tile is deployed or before it is removed. You
55
+
control which errands run the next time when you click **Apply Changes** to redeploy.
56
+
See the
57
+
[Errands](./tile-errands.html) for how <%=vars.platform_name%> to control when errands run, and how
58
+
to set default errand run rules in the tile.
49
59
50
60
At any level of integration, use [Concourse](./concourse.html) for continuous integration during development.
Copy file name to clipboardexpand all lines: migrating-credhub-credentials.html.md.erb
+12-8
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,14 @@ title: Migrating existing credentials to CredHub
3
3
owner: CredHub
4
4
---
5
5
6
-
Here is how to migrate non-configurable secrets from Ops Manager into CredHub.
6
+
You can migrate non-configurable secrets from Ops Manager into CredHub.
7
7
8
8
## <aid="cred-types"></a>CredHub credential types
9
9
10
-
CredHub uses BOSH credential types, which can have different names from Ops Manager credential types.
11
-
The following table lists the Ops Manager credential types you can migrate to CredHub and the corresponding CredHub credential types.
10
+
CredHub uses BOSH credential types, which can have different names than Ops Manager credential types.
11
+
12
+
The following table lists the Ops Manager credential types you can migrate to CredHub and the
13
+
corresponding CredHub credential types:
12
14
13
15
<table>
14
16
<tr>
@@ -47,11 +49,11 @@ See [Property and template references](./property-template-references.html#secre
47
49
48
50
## <aid="javascript"></a> Use the javaScript migration process
49
51
50
-
Tile authors can write a JavaScript migration to move their existing non-configurable secrets into CredHub. After a successful migration, Ops Manager deletes credentials from `installation.yml`.
52
+
Tile authors can write a JavaScript migration to move their existing non-configurable secrets into CredHub. After a successful migration, Ops Manager deletes credentials from the `installation.yml` file.
51
53
52
54
1. Use the following example to write the JavaScript migration.
53
55
Save the JavaScript file to the `PRODUCT/migrations/v1` directory of your `.pivotal` tile,
54
-
following the naming conventionsx in the [Update Values or Property Names Using JavaScript](./tile-upgrades.html) topic.
56
+
following the naming conventions in the [Update Values or Property Names using JavaScript](./tile-upgrades.html) topic.
55
57
56
58
```js
57
59
exports.migrate = function(input) {
@@ -97,10 +99,10 @@ following the naming conventionsx in the [Update Values or Property Names Using
97
99
type: password
98
100
```
99
101
100
-
101
102
<pclass="note">
102
103
<spanclass="note__title">Note</span>
103
-
While the property blueprint refers to the above type as <code>secret</code>, BOSH refers to the type as <code>password</code>. See the <ahref="#cred-types">CredHub Credential Types</a> table at the beginning of this topic for more information about credential types.
104
+
While the property blueprint refers to the type as <code>secret</code>, BOSH refers to the
105
+
type as <code>password</code>. See the <ahref="#cred-types">CredHub Credential Types</a> table at the beginning of this topic for more information about credential types.
104
106
</p>
105
107
106
108
1. In your manifest snippet, replace the existing secret value with the new triple-parenthesis syntax.
@@ -118,4 +120,6 @@ While the property blueprint refers to the above type as <code>secret</code>, BO
118
120
119
121
2. Run a [test deploy](./testing.html) of your tile.
120
122
121
-
3. Use an API endpoint to confirm that the credential is stored in the variable. For more information about the endpoint, see [Fetching Variable Names and Values](./get-credhub-vars.html).
123
+
3. Use an API endpoint to confirm that the credential is stored in the variable.
124
+
125
+
For more information about the endpoint, see [Fetching Variable Names and Values](./get-credhub-vars.html).
0 commit comments