Skip to content

Commit

Permalink
Small doc fixes (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
gibbleyg authored Aug 7, 2020
1 parent dda9533 commit 0706762
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 17 deletions.
18 changes: 9 additions & 9 deletions docs/deployment-manager-guide.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
## Generating a Deployment Manager template

The mpdev tool can autogenerate Deployment Manager templates from an
[autogen specification](./autogen-reference.md). Follow these steps to
build create a Deployment Manager template.
The `mpdev` tool can autogenerate Deployment Manager templates from an
[autogen specification](./autogen-reference.md). Follow these steps to create a
Deployment Manager template.

1. Use the `mpdev pkg get` command to retrieve a preconfigured autogen
specification. See an example [here](../examples/deployment-manager/autogen/singlevm/README.md).
1. Use `mpdev cfg set` to customize values in the retrieved autogen
specification, or edit the spec manually.
3. Execute `mpdev apply` to generate the Deployment Manager template.

## Upload solution to partner portal
## Upload solution to Partner Portal

Open [Partner Portal](https://console.cloud.google.com/partner/solutions) and
select your solution from the list of solutions, then follow these steps:

1. Next to **Deployment Package**, click **Edit**.
1. Select to **Upload a Package**, and then click **Continue**
1. Select the deployment package created by mpdev for **Upload a package**,
1. Select **Upload a Package**, and then click **Continue**
1. Select the deployment package created by `mpdev` for **Upload a package**,
uncheck the **Metadata selection** box and then click **Continue**.
1. Click **Save** to save changes.

**Warning:** Unchecking the **Metadata selection** box is crucial, so that
mpdev does not override the solution metadata configured in earlier steps of
the partner portal wizard.
**WARNING:** Unchecking the **Metadata selection** box is crucial, so that
`mpdev` does not override the solution metadata configured in earlier steps of
the Partner Portal wizard.
24 changes: 18 additions & 6 deletions docs/mpdev-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,36 +20,48 @@ these resources.

### Start from preconfigured mpdev template

The `pkg get` command downloads a preconfigured mpdev template. `mpdev pkg` is
The `pkg get` command downloads a preconfigured `mpdev` template. `mpdev pkg` is
a wrapper around
[`kpt pkg`](https://googlecontainertools.github.io/kpt/reference/pkg/get).

```bash
mpdev pkg get https://github.com/GoogleCloudPlatform/marketplace-tools.git/examples/deployment-manager/autogen/singlevm dir
mpdev pkg get https://github.com/GoogleCloudPlatform/marketplace-tools.git/examples/deployment-manager/autogen/singlevm mypackage
```

See the [README](../examples/deployment-manager/autogen/singlevm/README.md) in
the downloaded template for next steps.

### Optional: git commit mpdev template

Commit the package to git in order to track changes made when customizing the
`mpdev` template.

```bash
git init && git add . && git commit -m "Initial clone"
```

### Customize an mpdev template

The `cfg set` command can be used to programmatically customize values in a
preconfigured mpdev template.
preconfigured `mpdev` template.
`mpdev cfg` is a wrapper around
[`kpt cfg`](https://googlecontainertools.github.io/kpt/reference/cfg/set).

```bash
mpdev cfg set dir projectId YourProject
mpdev cfg set mypackage/ projectId <PROJECT_ID>
```

### Generate mpdev resources

The `apply` command creates resources from the mpdev template.

```bash
mpdev apply -f dir/configurations.yaml
mpdev apply -f mypackage/configurations.yaml
```

The `--dry-run` option can be used to validate the schema of configuration files
quickly without creating the `mpdev` resources.

```bash
mpdev apply --dry-run -f dir/configurations.yaml
mpdev apply --dry-run -f mypackage/configurations.yaml
```
2 changes: 1 addition & 1 deletion examples/deployment-manager/autogen/multivm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ gcloud compute --project=$PROJECT_ID images create redis --source-image=redis-v2

## Generating Deployment Manager Template

To use this mpdev package, execute the following command which will checkout this
To use this `mpdev` package, execute the following command which will checkout this
package to a directory named `redis`.

```
Expand Down
2 changes: 1 addition & 1 deletion examples/deployment-manager/autogen/singlevm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ gcloud compute --project=$PROJECT_ID images create wordpress --source-image=word

## Generating Deployment Manager Template

To use this mpdev package, execute the following command which will checkout this
To use this `mpdev` package, execute the following command which will checkout this
package to a directory named `wordpress`.

```
Expand Down

0 comments on commit 0706762

Please sign in to comment.