forked from mboldt/docs-tiledev
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html.md.erb
145 lines (108 loc) · 6.35 KB
/
index.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
---
title: Tanzu Operations Manager Tile Developer Guide
owner: Services
---
You can use the following VMware Tanzu Partners information to learn how to build and publish processes for an
Tanzu Operations Manager tile on [VMware Tanzu Network](https://network.tanzu.vmware.com/).
For advanced developers with previous experience building tiles, see [Property and template references](./property-template-references.html) and [Development workflow reference](./dev-workflow.html).
## <a id="tile-def"></a> What is a tile?
You can integrate tile software into <%= vars.platform_name %>. You can install tiles on
<%= vars.platform_name %>. Developers can use these services after they are installed.
Tile developers can publish tiles on VMware Tanzu Network, where services and tiles are available for download.
### Tile structure
Tiles are packaged as compressed files with a `.pivotal` file extension.
These compressed files require three subdirectories: `metadata`, `migrations`, and `releases`.
When you package your software with Tile Generator, it generates these subdirectories for you. You can perform different actions within each subdirectory:
<table class=“table”>
<thead>
<tr>
<th style="width: 20%">Directory</th>
<th>Description</th>
</tr>
</thead>
<tr>
<td><code>metadata</code></td>
<td>Configure settings for your software in a YAML file.
</tr>
<tr>
<td><code>migrations</code></td>
<td>Track changes across different releases in a <code>.js</code> file. Only tiles with multiple releases use this subdirectory. Do not edit the files in this subdirectory during your first tile release. </td>
</tr>
<tr>
<td><code>releases</code></td>
<td>Deploy your service source code and other inputs for your build, such as a BOSH release. </td>
</tr>
</table>
## <a id="tile-value"></a> Why build a tile?
There are multiple reasons to build and publish a tile on VMware Tanzu Network.
Tiles can help you:
* Find the widest possible audience for your service.
* Join a expanding ecosystem that can integrate your service.
* Operators and app developers can interact with your service in an accessible and standardized way.
## <a id="tile-steps"></a> Building your first tile
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://tanzu.vmware.com/partners/tech).
#### <a id="tools"></a> Step 1: Decide what to build
If you use the 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.
Before you start tile development, see [How <%= vars.app_runtime_abbr %> and <%= vars.platform_name %> services work](./cf-concepts.html).
Depending on what you build, you must install the following tools:
- [Tile Generator](./tile-generator.html#-how-to-use): Used to package your software into a tile.
- [BOSH Command Line Interface (CLI)](https://bosh.io/docs/cli-v2/)<: A CLI for running BOSH commands. You need BOSH commands to run Tile Generator.
- [Cloud Foundry Command Line Interface (cf CLI)](https://github.com/cloudfoundry/cli#downloads): A CLI for deploying and managing apps on Cloud Foundry. If you are developing on Cloud Foundry, you use cf CLI when building your tile.
- [Kubernetes Command Line Tool (kubectl)](https://kubernetes.io/docs/tasks/tools/install-kubectl/): A CLI for deploying and managing apps on Kubernetes. If you are developing on Kubernetes, you use kubectl when building your tile.
- [CF Dev](https://github.com/cloudfoundry-incubator/cfdev) (optional): A lightweight <%= vars.app_runtime_full %> installation for deploying and debugging apps locally. You can use Cloud Foundry Dev to run <%= vars.app_runtime_abbr %>
on your local workstation.
#### <a id="generate"></a> Step 2: Generate a tile
Tile Generator simplifies building tiles. To use the Tile Generator, upload your software components,
such as the service broker, buildpack, and Docker image, and then the tool generates a base tile.
For information about setting up the Tile Generator and building a base tile, see [Tile Generator](./tile-generator.html).
#### <a id="test"></a> Step 3: Test your tile
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, for example, Amazon Web Services (AWS) or Google Cloud Platform (GCP). You can upload, configure, and
install your tile in PIE as an operator does.
To gain access to your PIE, reach out to your contact at <%= vars.company_name %> or
[register as a partner](https://tanzu.vmware.com/partners/tech).
If you already have access to your PIE, for information about how to log in, see [Development Environments](./environments.html).
#### <a id="document"></a> Step 4: Document your tile
When you are ready to publish your tile, write documentation. Documentation is valuable for operators
who use your tile.
For more information about how to write and publish documentation for your tile, see [Tile Documentation](./tile-documentation.html).
#### <a id="publish"></a> Step 5: Publish your tile on VMware Tanzu Network
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.
<table class=“table”>
<thead>
<tr>
<th>Audience</th>
<th>Benefits</th>
</tr>
</thead>
<tr>
<td>Operators</td>
<td>
<ul>
<br>
<li>Download and install your service as a tile.</li>
<li>Configure your service using a UI.</li>
<li>Update your service with a single click.</li>
</ul>
</td>
</tr>
<tr>
<td>Developers</td>
<td>
<ul>
<br>
<li>See your service on VMware Tanzu Network.</li>
<li>Subscribe to the service plans you want.</li>
<li>Create instances of your service and call them from their apps.</li>
<li>Support a continuous and fast development cycle.</li>
</ul>
</td>
</tr>
</table>
For information about the release cycle for Partner tiles, see [Partner Software Release Cycle](./releases.html).
## <a id="contact"></a> Support
To learn more about the VMware Tanzu ISV Partner Program or request help with your integration project, see [Contact Us](./contacts.html).