From 3aeea1085094e9f2b3908442daf264fab043abec Mon Sep 17 00:00:00 2001 From: Christian Lechner Date: Mon, 17 Jun 2024 08:15:28 +0200 Subject: [PATCH] docs: fix broken link, align local references --- migration-guide/data-sources/space.md | 2 +- migration-guide/data-sources/user.md | 2 +- migration-guide/resources/app.md | 2 +- migration-guide/resources/org.md | 2 +- migration-guide/resources/service_credential_binding.md | 2 +- migration-guide/resources/space.md | 6 +++--- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/migration-guide/data-sources/space.md b/migration-guide/data-sources/space.md index 2b3bcee..1066973 100644 --- a/migration-guide/data-sources/space.md +++ b/migration-guide/data-sources/space.md @@ -14,6 +14,6 @@ Gets information on a Cloud Foundry space. | Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description | | --- | --- | --- | --- | | org_name | 🔴 | 🟢 | - | -| org | 🔵 | 🟢 | Space can now be queried only by `org` GUID and not by `org_name`. If one knows org_name and not org GUID, one can obtain the id value from [`cloudfoundry_org`](https://github.com/SAP/terraform-provider-cloudfoundry/blob/migration_docs/docs/data-sources/org.md) resource by specifying `name`. | +| org | 🔵 | 🟢 | Space can now be queried only by `org` GUID and not by `org_name`. If one knows org_name and not org GUID, one can obtain the id value from [`cloudfoundry_org`](./org.md) resource by specifying `name`. | | allow_ssh | 🟠 | 🔴 | - | | isolation_segment | 🟠 | 🔴 | - | diff --git a/migration-guide/data-sources/user.md b/migration-guide/data-sources/user.md index a9b5042..09e80ec 100644 --- a/migration-guide/data-sources/user.md +++ b/migration-guide/data-sources/user.md @@ -13,6 +13,6 @@ Gets information on Cloud Foundry users with a given username. | Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description | | --- | --- | --- | --- | -| org_id | 🔴 | 🟢 | For fetching specific user under a particular org in current provider, one can set the `org` attribute in [`cloudfoundry_users`](https://github.com/SAP/terraform-provider-cloudfoundry/blob/migration_docs/docs/data-sources/users.md) resource and then from `users` attribute output, filter the user with `username` desired. | +| org_id | 🔴 | 🟢 | For fetching specific user under a particular org in current provider, one can set the `org` attribute in [`cloudfoundry_user`](./user.md) resource and then from `users` attribute output, filter the user with `username` desired. | | users | 🟠 | 🔴 | - | | id | 🔴 | 🟠 | The current provider returns multiple users if available with same user name in the `users` attribute unlike the community provider. Therefore the id is present in the respective user resources in `users` output. | diff --git a/migration-guide/resources/app.md b/migration-guide/resources/app.md index 420c86c..424f00a 100644 --- a/migration-guide/resources/app.md +++ b/migration-guide/resources/app.md @@ -20,7 +20,7 @@ Provides a Cloud Foundry resource to manage applications. | enable_ssh | 🔴 | 🟢 | It can be enabled on a space level. For further details, refer [here](https://docs.cloudfoundry.org/devguide/deploy-apps/ssh-apps.html#config-ssh-access-apps). | | stopped | 🔴 | 🟢 | `stopped` attribute functionality can be achieved by setting `instances` to 0. | | routes.route | 🟢 | 🟢 | In the new provider, FQDN needs to be specified instead of the route GUID in the community provider. Route resource is automatically created if not present. | -| routes.port | 🔴 | 🟢 | Not present in V3 manifest schema. Can be set in `port` attribute of [`cloudfoundry_route`](https://github.com/SAP/terraform-provider-cloudfoundry/blob/main/docs/resources/route.md) resource. | +| routes.port | 🔴 | 🟢 | Not present in V3 manifest schema. Can be set in `port` attribute of [`cloudfoundry_route`]( ./route.md) resource. | | routes.protocol | 🟢 | 🔴 | - | | health_check_interval | 🟢 | 🔴 | - | | log_rate_limit_per_second | 🟢 | 🔴 | - | diff --git a/migration-guide/resources/org.md b/migration-guide/resources/org.md index cbcc8e3..c43910d 100644 --- a/migration-guide/resources/org.md +++ b/migration-guide/resources/org.md @@ -14,6 +14,6 @@ Provides a Cloud Foundry resource for managing Cloud Foundry organizations | Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description | | --- | --- | --- | --- | -| quota | 🟠| 🟢 | One cannot set quota as it is a read-only attribute in the current provider. For setting quota use resource [`cloudfoundry_org_quota`](https://github.com/SAP/terraform-provider-cloudfoundry/blob/main/docs/resources/org_quota.md). | +| quota | 🟠| 🟢 | One cannot set quota as it is a read-only attribute in the current provider. For setting quota use resource [`cloudfoundry_org_quota`](./org_quota.md). | | suspended | 🟢 | 🔴 | - | | delete_recursive_allowed | 🔴 | 🟢 | V3 API by default follows recursive deletion. | diff --git a/migration-guide/resources/service_credential_binding.md b/migration-guide/resources/service_credential_binding.md index 1b23773..ef2f102 100644 --- a/migration-guide/resources/service_credential_binding.md +++ b/migration-guide/resources/service_credential_binding.md @@ -13,7 +13,7 @@ Provides a resource for managing service credential bindings in Cloud Foundry. C | Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description | | --- | --- | --- | --- | -| credentials | 🔴 | 🟠 | Attribute not returned as part of V3 API resource. However, it is obtainable from `credential_binding` attribute of data source [`cloudfoundry_service_credential_binding`](https://github.com/SAP/terraform-provider-cloudfoundry/blob/main/docs/data-sources/service_credential_binding.md). | +| credentials | 🔴 | 🟠 | Attribute not returned as part of V3 API resource. However, it is obtainable from `credential_binding` attribute of data source [`cloudfoundry_service_credential_binding`](../data-sources/service_credential_binding.md). | | type | 🔵 | 🔴 | Need to specify whether binding is of type app or key. | | labels | 🟢 | 🔴 | - | | annotations | 🟢 | 🔴 | - | diff --git a/migration-guide/resources/space.md b/migration-guide/resources/space.md index 0ade555..5cc7061 100644 --- a/migration-guide/resources/space.md +++ b/migration-guide/resources/space.md @@ -13,7 +13,7 @@ Provides a Cloud Foundry resource for managing Cloud Foundry spaces within organ | Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description | | --- | --- | --- | --- | -| quota | 🟠 | 🟢 | One cannot set quota as it is a read-only attribute in the current provider. For setting quota use resource [`cloudfoundry_space_quota`](https://github.com/SAP/terraform-provider-cloudfoundry/blob/main/docs/resources/space_quota.md). | -| asgs| 🔴 | 🟢 | Security groups not present in space resource as part of V3 API Spec. One can however set it with `running_spaces` attribute from resource [`cloudfoundry_security_group`](https://github.com/SAP/terraform-provider-cloudfoundry/blob/main/docs/resources/security_group.md). | -| staging_asgs| 🔴 | 🟢 | Staging Security groups not present in space resource as part of V3 API Spec. One can however set it with `staging_spaces` attribute from resource [`cloudfoundry_security_group`](https://github.com/SAP/terraform-provider-cloudfoundry/blob/main/docs/resources/security_group.md). | +| quota | 🟠 | 🟢 | One cannot set quota as it is a read-only attribute in the current provider. For setting quota use resource [`cloudfoundry_space_quota`](./space_quota.md). | +| asgs| 🔴 | 🟢 | Security groups not present in space resource as part of V3 API Spec. One can however set it with `running_spaces` attribute from resource [`cloudfoundry_security_group`](./security_group.md). | +| staging_asgs| 🔴 | 🟢 | Staging Security groups not present in space resource as part of V3 API Spec. One can however set it with `staging_spaces` attribute from resource [`cloudfoundry_security_group`](./security_group.md). | | delete_recursive_allowed | 🔴 | 🟢 | V3 API by default follows recursive deletion. |