Skip to content

Commit

Permalink
chore: Remove SAP References
Browse files Browse the repository at this point in the history
Remove SAP references from migration guide
Remove SAP references from README, CONTRIBUTING & DEVELOPER docs
Update sonar cloud references
closes #64
  • Loading branch information
vipinvkmenon committed Nov 8, 2024
1 parent 33f1a8f commit e185cd8
Show file tree
Hide file tree
Showing 32 changed files with 44 additions and 76 deletions.
29 changes: 0 additions & 29 deletions .reuse/dep5

This file was deleted.

15 changes: 8 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Contributing

## Code of Conduct

All members of the project community must abide by the [SAP Open Source Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md).
Only by respecting each other we can develop a productive, collaborative community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [a project maintainer](.reuse/dep5).
We thank you for taking an interest in our project and contributing to it. Contributions can be in the form of raising bugs or fixing them as well. PRs and discussions for new features and improvements are welcome as well. Discussions can be done in the discussion section.

## Engaging in Our Project

Expand All @@ -28,8 +24,13 @@ You are welcome to contribute code in order to fix a bug or to implement a new f

The following rule governs code contributions:

* Contributions must be licensed under the [Apache 2.0 License](./LICENSE)
* Due to legal reasons, contributors will be asked to accept a Developer Certificate of Origin (DCO) when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/).
All contributors to this project must have a signed Contributor License Agreement (**"CLA"**) on file with us. The CLA grants us the permissions we need to use and redistribute your contributions as part of the project; you or your employer retain the copyright to your contribution. Before a PR can pass all required checks, our CLA action will prompt you to accept the agreement.

Head over to the [Linux Foundation EasyCLA](https://api.easycla.lfx.linuxfoundation.org/v2/repository-provider/github/sign/1797134/394751388/618/#/?version=2).


Note: A signed CLA is required even for minor updates. If you see something trivial that needs to be fixed, but are unable or unwilling to sign a CLA, the maintainers will be happy to make the change on your behalf. If you can
describe the change in a bug report, it would be greatly appreciated.

## Issues and Planning

Expand Down
2 changes: 1 addition & 1 deletion DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Refer [authentication](./Authentication.md) to login to the environment.

**Step 1:** Open the repository in GitHub Codespaces via the button:

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/SAP/terraform-provider-cloudfoundry)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/cloudfoundry/terraform-provider-cloudfoundry)

**Step 2:** There is no step 2 😎.

Expand Down
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Terraform Provider for Cloud Foundry

![Golang](https://img.shields.io/badge/Go-1.23-informational)
[![REUSE status](https://api.reuse.software/badge/github.com/cloudfoundry/terraform-provider-cloudfoundry)](https://api.reuse.software/info/github.com/cloudfoundry/terraform-provider-cloudfoundry)

## About This Project

The Terraform provider for [Cloud Foundry](https://www.cloudfoundry.org/) allows the management of resources via [Terraform](https://terraform.io/).
Expand Down Expand Up @@ -37,7 +37,3 @@ If you find any bug that may be a security problem, please follow our [instructi
## Code of Conduct

Members, contributors, and leaders pledge to make participation in our community a harassment-free experience. By participating in this project, you agree to always abide by its [Code of Conduct](https://www.cloudfoundry.org/wp-content/uploads/2015/09/CFF_Code_of_Conduct.pdf).

## Licensing

Copyright 2024 SAP SE or an SAP affiliate company and `terraform-provider-cloudfoundry` contributors. See our [LICENSE](LICENSE) for copyright and license information. Detailed information, including third-party components and their licensing/copyright information, is available [via the REUSE tool](https://api.reuse.software/info/github.com/cloudfoundry/terraform-provider-cloudfoundry).
2 changes: 1 addition & 1 deletion migration-guide/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ provider "cloudfoundry" {
password = "your-password"
}
#Configure the new SAP Terraform Cloud foundry provider with alias
#Configure the new Terraform Cloud foundry provider with alias
provider "cloudfoundry-v3-new" {
api_url = "https://api.example.com"
username = "your-username"
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/data-sources/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gets information on a Cloud Foundry application.
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| name_or_id | 🔴 | 🟢 | Only application name has to be specified in `name` |
| name | 🔵 | 🟠 | - |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/data-sources/domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gets information on a Cloud Foundry domain.
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| sub_domain | 🔴 | 🟢 | `sub_domain` and `domain` attributes from community provider values need to be combined to a FQDN and value should be set in `name` attribute in the format of 'sub_domain.domain' |
| domain | 🔴| 🟢 | Refer above |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/data-sources/org.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gets information on a Cloud Foundry organization.
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| quota | 🟠| 🔴 | - |
| suspended | 🟠 | 🔴 | - |
2 changes: 1 addition & 1 deletion migration-guide/data-sources/org_quota.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gets information on a Cloud Foundry organization quota.
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| orgs | 🟠 | 🔴 | - |
| total_app_log_rate_limit | 🟠 | 🔴 | - |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/data-sources/route.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gets information on a Cloud Foundry route.
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| id | 🔴 | 🟠 | The current provider returns multiple routes if available with same domain name in the `routes` attribute unlike the community provider. Therefore the id is present in the respective route resources in `routes` output |
| hostname | 🔴 | 🟢 | `hostname` has been changed to `host` to maintain conformity with V3 API |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/data-sources/security_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gets information on a Cloud Foundry application security group. Named as [`cloud
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| globally_enabled_running | 🟠| 🔴 | - |
| globally_enabled_staging | 🟠| 🔴 | - |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/data-sources/service_credential_binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gets information on Service Credential Bindings for a given service instance. Co
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| name | 🟢 | 🔵 | Since `cloudfoundry_service_key` resource in community provider can only query for service keys and not app bindings, name has been made optional now as app bindings need not have names. |
| app | 🟢 | 🔴 | One can query for a specific app credential_binding by providing its GUID |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/data-sources/service_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Provides a data source for fetching information of a service instance in Cloud F
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| name_or_id | 🔴 | 🟢 | Only service instance name has to be specified in `name` |
| labels | 🟠 | 🔴 | - |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/data-sources/space.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gets information on a Cloud Foundry space.
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| 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`](/docs/data-sources/org.md) data source by specifying `name`. |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/data-sources/space_quota.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gets information on a Cloud Foundry space quota.
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| spaces | 🟠 | 🔴 | - |
| total_app_log_rate_limit | 🟠 | 🔴 | - |
Expand Down
4 changes: 2 additions & 2 deletions migration-guide/data-sources/stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

Gets information on a Cloud Foundry stack.

| SAP Cloudfoundry Provider | Community Cloudfoundry Provider |
| Cloud Foundry Provider | Community Cloudfoundry Provider |
| -- | -- |
| <pre>data "cloudfoundry_stack" "mystack" {</br> name = "my_custom_stack"</br>}</br></pre>|<pre>data "cloudfoundry_stack" "mystack" {</br> name = "my_custom_stack"</br>}</br></pre> |

## Differences
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name| SAP Cloudfoundry Provider(new)| Community Provider(old) |Description
| Attribute name| Cloud Foundry Provider| Community Provider(old) |Description
|---| ---| ---| ---|
|build_rootfs_image | 🟠|🔴| - |
|run_rootfs_image | 🟠|🔴| - |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/data-sources/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gets information on Cloud Foundry users with a given username.
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| 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`](/docs/data-sources/users.md) data-source and then from `users` attribute output, filter the user with `username` desired. |
| users | 🟠 | 🔴 | - |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/resources/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Provides a Cloud Foundry resource to manage applications.
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| org_name| 🔵 | 🔴 | Organization name where space is present has to be specified. |
| space_name | 🔵 | 🔴 | Instead of specifying guid for `space` attribute in the old community provider, user should specify space name in `space_name` attribute for the new provider. |
Expand Down
4 changes: 2 additions & 2 deletions migration-guide/resources/buildpack.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

Provides a Cloud Foundry resource to manage buildpacks.

| SAP Cloudfoundry Provider |Community Cloudfoundry Provider |
| Cloud Foundry Provider |Community Cloudfoundry Provider |
| -- | -- |
| <pre>resource "cloudfoundry_buildpack" "bp" {</br> name = "hi"</br> position = 1</br> stack = "cflinuxfs3"</br> enabled = false</br> locked = true</br> labels = { "hi" : "fi" }</br> path = "something.zip"</br>}</br></pre> |<pre>resource "cloudfoundry_buildpack" "bp" {</br> name = "hi"</br> position = 1</br> enabled = false</br> locked = true</br> labels = { "hi" : "fi" }</br> path = "something.zip"</br>}</br></pre> |

## Differences
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name| SAP Cloudfoundry Provider(new)| Community Provider(old) | Description
| Attribute name| Cloud Foundry Provider| Community Provider(old) | Description
|---| ---| ---| ---|
|path| 🟢| 🔵 | - |
|stack | 🟢 |🔴| - |
2 changes: 1 addition & 1 deletion migration-guide/resources/domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Provides a Cloud Foundry resource for managing shared or private domains in Clou
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
|| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
|| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| sub_domain | 🔴 | 🟢 | `sub_domain` and `domain` attributes from community provider values need to be combined to a FQDN and value should be set in `name` attribute. |
| domain | 🔴| 🟢 | Refer above |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/resources/org.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Provides a Cloud Foundry resource for managing Cloud Foundry organizations
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| 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`](/docs/resources/org_quota.md). |
| suspended | 🟢 | 🔴 | - |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/resources/org_quota.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Provides a Cloud Foundry resource to manage org quota definitions. Orgs can be b
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| orgs | 🟢 | 🔴 | Orgs to which the org quota applies has to be set here. |
| total_app_log_rate_limit | 🟢 | 🔴 | - |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/resources/route.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Provides a Cloud Foundry resource for managing Cloud Foundry application routes.
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| hostname | 🔴 | 🟢 | `hostname` has been changed to `host` to maintain conformity with V3 API. |
| host | 🟢 | 🔴 |- |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/resources/security_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Provides an application security group resource for Cloud Foundry. Named as [`cl
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| Community Cloud Foundry Provider (old) | Description |
| --- | --- | --- | --- |
| globally_enabled_running | 🟢 | 🔴 | Achieves functionality of [`cloudfoundry_default_asg`](https://github.com/cloudfoundry-community/terraform-provider-cloudfoundry/blob/main/docs/resources/default_asg.md) in the community provider with attribute `name=running`. |
| globally_enabled_staging | 🟢 | 🔴 | Achieves functionality of [`cloudfoundry_default_asg`](https://github.com/cloudfoundry-community/terraform-provider-cloudfoundry/blob/main/docs/resources/default_asg.md) in the community provider with attribute `name=staging`. |
Expand Down
4 changes: 2 additions & 2 deletions migration-guide/resources/service_broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

Provides a Cloud Foundry resource for managing service brokers.

| SAP Cloudfoundry Provider |Community Cloudfoundry Provider |
| Cloud Foundry Provider |Community Cloudfoundry Provider |
| -- | -- |
| <pre>resource "cloudfoundry_service_broker" "mysql" { </br> name = "broker"</br> url = "example.broker.com"</br> username = "test"</br> password = "test"</br>}</br></pre> |<pre>resource "cloudfoundry_service_broker" "mysql" { </br> name = "broker"</br> url = "example.broker.com"</br> username = "test"</br> password = "test"</br>}</br></pre> |

## Differences
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name| SAP Cloudfoundry Provider(new)| Community Provider(old) | Description
| Attribute name| Cloud Foundry Provider| Community Provider(old) | Description
|---| ---| ---| ---|
|fail_when_catalog_not_accessible | 🔴| 🟢 | - |
|service_plans | 🔴 |🟠| - |
Expand Down
2 changes: 1 addition & 1 deletion migration-guide/resources/service_credential_binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Provides a resource for managing service credential bindings in Cloud Foundry. C
> [!NOTE]
> 🔵 Required 🟢 Optional 🟠 Computed 🔴 Not present
| Attribute name | SAP Cloud Foundry Provider (new)| Community Cloud Foundry Provider (old) | Description |
| Attribute name | Cloud Foundry Provider| 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`](/docs/data-sources/service_credential_binding.md). |
| type | 🔵 | 🔴 | Need to specify whether binding is of type app or key. |
Expand Down
Loading

0 comments on commit e185cd8

Please sign in to comment.