diff --git a/docs/howto/newoperatorguide.md b/docs/howto/newoperatorguide.md index da35f5dad19..a07810015d4 100644 --- a/docs/howto/newoperatorguide.md +++ b/docs/howto/newoperatorguide.md @@ -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 @@ -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 @@ -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). ``` @@ -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. diff --git a/docs/services/apimgmt/apimgmt.md b/docs/services/apimgmt/apimgmt.md index bcf9a46cf90..e63763a48da 100644 --- a/docs/services/apimgmt/apimgmt.md +++ b/docs/services/apimgmt/apimgmt.md @@ -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. diff --git a/docs/services/appinsights/appinsights.md b/docs/services/appinsights/appinsights.md index ec24f5d76d1..d146e57f845 100644 --- a/docs/services/appinsights/appinsights.md +++ b/docs/services/appinsights/appinsights.md @@ -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. diff --git a/docs/services/azuresql/azuresql.md b/docs/services/azuresql/azuresql.md index 0761385f673..bda6de20577 100644 --- a/docs/services/azuresql/azuresql.md +++ b/docs/services/azuresql/azuresql.md @@ -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 diff --git a/docs/services/eventhub/eventhub.md b/docs/services/eventhub/eventhub.md index 619705017c3..60b4c5b57e7 100644 --- a/docs/services/eventhub/eventhub.md +++ b/docs/services/eventhub/eventhub.md @@ -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 diff --git a/docs/services/keyvault/keyvault.md b/docs/services/keyvault/keyvault.md index dfcac79daa6..45ba52bb685 100644 --- a/docs/services/keyvault/keyvault.md +++ b/docs/services/keyvault/keyvault.md @@ -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. diff --git a/docs/services/mysql/mysql.md b/docs/services/mysql/mysql.md index 3a4c7e229d3..e4a9558caa9 100644 --- a/docs/services/mysql/mysql.md +++ b/docs/services/mysql/mysql.md @@ -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. diff --git a/docs/services/postgresql/postgresql.md b/docs/services/postgresql/postgresql.md index 93de0567444..a8464cfb004 100644 --- a/docs/services/postgresql/postgresql.md +++ b/docs/services/postgresql/postgresql.md @@ -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. diff --git a/docs/services/rediscache/rediscache.md b/docs/services/rediscache/rediscache.md index 34673a400cd..f51a5898472 100644 --- a/docs/services/rediscache/rediscache.md +++ b/docs/services/rediscache/rediscache.md @@ -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. diff --git a/docs/services/resourcegroup/resourcegroup.md b/docs/services/resourcegroup/resourcegroup.md index 3d24162059c..4e0d97c0f3f 100644 --- a/docs/services/resourcegroup/resourcegroup.md +++ b/docs/services/resourcegroup/resourcegroup.md @@ -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. diff --git a/docs/services/storage/blobcontainer.md b/docs/services/storage/blobcontainer.md index 66ebc4abcad..0091af1704c 100644 --- a/docs/services/storage/blobcontainer.md +++ b/docs/services/storage/blobcontainer.md @@ -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. \ No newline at end of file +You can follow the steps [here](/docs/topics/resourceprovision.md) to deploy, view and delete resources. \ No newline at end of file diff --git a/docs/services/storage/storageaccount.md b/docs/services/storage/storageaccount.md index 87735f26ed5..cc4dd5232b8 100644 --- a/docs/services/storage/storageaccount.md +++ b/docs/services/storage/storageaccount.md @@ -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). diff --git a/docs/services/virtualmachine/virtualmachine.md b/docs/services/virtualmachine/virtualmachine.md index 6f302ca814e..28e15454783 100644 --- a/docs/services/virtualmachine/virtualmachine.md +++ b/docs/services/virtualmachine/virtualmachine.md @@ -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. diff --git a/docs/services/virtualnetwork/loadbalancer.md b/docs/services/virtualnetwork/loadbalancer.md index 665767d1f61..5956c86c51b 100644 --- a/docs/services/virtualnetwork/loadbalancer.md +++ b/docs/services/virtualnetwork/loadbalancer.md @@ -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. diff --git a/docs/services/virtualnetwork/networkinterface.md b/docs/services/virtualnetwork/networkinterface.md index ec090426548..d0ad2b0a1ab 100644 --- a/docs/services/virtualnetwork/networkinterface.md +++ b/docs/services/virtualnetwork/networkinterface.md @@ -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. diff --git a/docs/services/virtualnetwork/publicipaddress.md b/docs/services/virtualnetwork/publicipaddress.md index adc1ea63e2d..a684f93c5d8 100644 --- a/docs/services/virtualnetwork/publicipaddress.md +++ b/docs/services/virtualnetwork/publicipaddress.md @@ -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. diff --git a/docs/services/virtualnetwork/virtualnetwork.md b/docs/services/virtualnetwork/virtualnetwork.md index c9e328bfece..9fb3e3d02e9 100644 --- a/docs/services/virtualnetwork/virtualnetwork.md +++ b/docs/services/virtualnetwork/virtualnetwork.md @@ -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. diff --git a/docs/services/vmscaleset/vmscaleset.md b/docs/services/vmscaleset/vmscaleset.md index ccfda1176f2..2f215cba038 100644 --- a/docs/services/vmscaleset/vmscaleset.md +++ b/docs/services/vmscaleset/vmscaleset.md @@ -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. diff --git a/docs/virtualmachineextension/virtualmachineextension.md b/docs/virtualmachineextension/virtualmachineextension.md index 581278261f3..a81c664b045 100644 --- a/docs/virtualmachineextension/virtualmachineextension.md +++ b/docs/virtualmachineextension/virtualmachineextension.md @@ -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.