Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation bugs #1117

Merged
merged 2 commits into from
May 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/howto/newoperatorguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ go build -o bin/manager main.go
- set `instance.Status.Provisioned` to `true` and `instance.Status.Provisioning` to `false`

```go
func (p *AzureNewTypeClient) Ensure(ctx context.Context, obj runtime.Object) (found bool, err error) {
func (p *AzureNewTypeClient) Ensure(ctx context.Context, obj runtime.Object, opts ...resourcemanager.ConfigOption) (bool, error) {
instance, err := p.convert(obj)
if err != nil {
return true, err
Expand All @@ -193,7 +193,7 @@ go build -o bin/manager main.go
return true, nil
}

func (p *AzureNewTypeClient) Delete(ctx context.Context, obj runtime.Object) (found bool, err error) {
func (p *AzureNewTypeClient) Delete(ctx context.Context, obj runtime.Object, opts ...resourcemanager.ConfigOption) (bool, error) {
instance, err := p.convert(obj)
if err != nil {
return true, err
Expand Down Expand Up @@ -304,6 +304,13 @@ go build -o bin/manager main.go
Expect(err).ToNot(HaveOccurred())
```

***Note: Since we've moved away from using Ginkgo for our tests, you will need to remove the following lines in `suite_test.go` that is auto-generated by Kubebuilder.***

```go
err = azurev1alpha1.AddToScheme(scheme.Scheme)
Expect(err).NotTo(HaveOccurred())
```

11. Install the new CRD and generate the manifests needed using the following commands. This is required in order to generate canonical resource definitions (manifests as errors about a DeepCopyObject() method missing).

```
Expand All @@ -329,6 +336,8 @@ go build -o bin/manager main.go
charts/index.yaml
```

13. Finally, make sure you add documentation for your operator under `/docs/services`.

**Notes:**

- Run `make manifests` if you find the property you add doesn't work.
Expand Down
2 changes: 1 addition & 1 deletion docs/services/apimgmt/apimgmt.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ The spec consists of the following fields:

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/appinsights/appinsights.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ For more details on where the secrets are stored, look [here](/docs/secrets.md)

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/azuresql/azuresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ If you are using Kube for storing secrets, there will be one secret with name `<

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.

## Demo

Expand Down
2 changes: 1 addition & 1 deletion docs/services/eventhub/eventhub.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ As an output of deployment, the operator stores a JSON formatted secret with the

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.

## How would you use the Eventhub Operator from a real application

Expand Down
2 changes: 1 addition & 1 deletion docs/services/keyvault/keyvault.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ ALTER COLUMN ENCRYPTION KEY key_name

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/mysql/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ The `server` indicates the MySQL server on which you want to configure the new M

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/postgresql/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ The `server` indicates the PostgreSQL server on which you want to configure the

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/rediscache/rediscache.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ _Note:_ When the `startIP` and `endIP` are 0.0.0.0, it denotes a special case th

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/resourcegroup/resourcegroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ The Resource group operator can be used to provision a Resource group given the

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/storage/blobcontainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ A Blob Container needs the following fields to deploy, along with a location and

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/storage/storageaccount.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ A Storage Account needs the following fields to deploy, along with a location an

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.

## Secrets
After creating a storage account, the operator stores a JSON formatted secret with the following fields. For more details on where the secrets are stored, look [here](/docs/secrets.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/services/virtualmachine/virtualmachine.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Not available.

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/virtualnetwork/loadbalancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ Not available.

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/virtualnetwork/networkinterface.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Not available.

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/virtualnetwork/publicipaddress.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Not available.

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/virtualnetwork/virtualnetwork.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ You are able to specify a single or multiple subnets for your virtual network.

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/services/vmscaleset/vmscaleset.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ Not available.

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.
2 changes: 1 addition & 1 deletion docs/virtualmachineextension/virtualmachineextension.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ A Virtual Machine Extension needs the following fields to deploy, along with a l

## Deploy, view and delete resources

You can follow the steps [here](/docs/customresource.md) to deploy, view and delete resources.
You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources.