Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tmunzer committed Dec 13, 2024
1 parent e7db51b commit c498c96
Show file tree
Hide file tree
Showing 6 changed files with 312 additions and 26 deletions.
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,10 @@ compliance:
#(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
#OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

go get github.com/chrismarget-j/go-licenses || exit 1 ;\
go run github.com/chrismarget-j/go-licenses save --ignore github.com/Juniper --ignore golang.org/x/sys --save_path Third_Party_Code --force ./... || exit 1 ;\
go run github.com/chrismarget-j/go-licenses report --ignore github.com/Juniper --ignore golang.org/x/sys --template .notices.tpl ./... > Third_Party_Code/NOTICES.md || exit 1 ;\
go mod tidy ;\

doc:
tfplugindocs generate
Expand Down
54 changes: 28 additions & 26 deletions Third_Party_Code/NOTICES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
## github.com/apimatic/go-core-runtime

* Name: github.com/apimatic/go-core-runtime
* Version: v0.0.24
* License: [MIT](https://github.com/apimatic/go-core-runtime/blob/v0.0.24/LICENSE)
* Version: v0.0.27
* License: [MIT](https://github.com/apimatic/go-core-runtime/blob/v0.0.27/LICENSE)

```
MIT License
Expand Down Expand Up @@ -32,8 +32,8 @@ SOFTWARE.
## github.com/fatih/color

* Name: github.com/fatih/color
* Version: v1.17.0
* License: [MIT](https://github.com/fatih/color/blob/v1.17.0/LICENSE.md)
* Version: v1.18.0
* License: [MIT](https://github.com/fatih/color/blob/v1.18.0/LICENSE.md)

```
The MIT License (MIT)
Expand Down Expand Up @@ -166,8 +166,8 @@ SOFTWARE.
## github.com/hashicorp/go-plugin

* Name: github.com/hashicorp/go-plugin
* Version: v1.6.1
* License: [MPL-2.0](https://github.com/hashicorp/go-plugin/blob/v1.6.1/LICENSE)
* Version: v1.6.2
* License: [MPL-2.0](https://github.com/hashicorp/go-plugin/blob/v1.6.2/LICENSE)

```
Copyright (c) 2016 HashiCorp, Inc.
Expand Down Expand Up @@ -906,8 +906,8 @@ Exhibit B - "Incompatible With Secondary Licenses" Notice
## github.com/hashicorp/terraform-plugin-framework

* Name: github.com/hashicorp/terraform-plugin-framework
* Version: v1.11.0
* License: [MPL-2.0](https://github.com/hashicorp/terraform-plugin-framework/blob/v1.11.0/LICENSE)
* Version: v1.13.0
* License: [MPL-2.0](https://github.com/hashicorp/terraform-plugin-framework/blob/v1.13.0/LICENSE)

```
Copyright (c) 2021 HashiCorp, Inc.
Expand Down Expand Up @@ -1272,8 +1272,8 @@ Exhibit B - “Incompatible With Secondary Licenses” Notice
## github.com/hashicorp/terraform-plugin-framework-validators

* Name: github.com/hashicorp/terraform-plugin-framework-validators
* Version: v0.13.0
* License: [MPL-2.0](https://github.com/hashicorp/terraform-plugin-framework-validators/blob/v0.13.0/LICENSE)
* Version: v0.15.0
* License: [MPL-2.0](https://github.com/hashicorp/terraform-plugin-framework-validators/blob/v0.15.0/LICENSE)

```
Copyright (c) 2022 HashiCorp, Inc.
Expand Down Expand Up @@ -1638,8 +1638,8 @@ Exhibit B - “Incompatible With Secondary Licenses” Notice
## github.com/hashicorp/terraform-plugin-go

* Name: github.com/hashicorp/terraform-plugin-go
* Version: v0.23.0
* License: [MPL-2.0](https://github.com/hashicorp/terraform-plugin-go/blob/v0.23.0/LICENSE)
* Version: v0.25.0
* License: [MPL-2.0](https://github.com/hashicorp/terraform-plugin-go/blob/v0.25.0/LICENSE)

```
Copyright (c) 2020 HashiCorp, Inc.
Expand Down Expand Up @@ -3101,10 +3101,12 @@ Exhibit B - “Incompatible With Secondary Licenses” Notice
## github.com/hashicorp/yamux

* Name: github.com/hashicorp/yamux
* Version: v0.1.1
* License: [MPL-2.0](https://github.com/hashicorp/yamux/blob/v0.1.1/LICENSE)
* Version: v0.1.2
* License: [MPL-2.0](https://github.com/hashicorp/yamux/blob/v0.1.2/LICENSE)

```
Copyright (c) 2014 HashiCorp, Inc.
Mozilla Public License, version 2.0
1. Definitions
Expand Down Expand Up @@ -3764,8 +3766,8 @@ THE SOFTWARE.
## github.com/tmunzer/mistapi-go/mistapi

* Name: github.com/tmunzer/mistapi-go/mistapi
* Version: v0.3.6
* License: [MIT](https://github.com/tmunzer/mistapi-go/blob/v0.3.6/LICENSE)
* Version: v0.4.22
* License: [MIT](https://github.com/tmunzer/mistapi-go/blob/v0.4.22/LICENSE)

```
License:
Expand Down Expand Up @@ -3866,8 +3868,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
## golang.org/x/net

* Name: golang.org/x/net
* Version: v0.28.0
* License: [BSD-3-Clause](https://cs.opensource.google/go/x/net/+/v0.28.0:LICENSE)
* Version: v0.32.0
* License: [BSD-3-Clause](https://cs.opensource.google/go/x/net/+/v0.32.0:LICENSE)

```
Copyright 2009 The Go Authors.
Expand Down Expand Up @@ -3903,8 +3905,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
## golang.org/x/text

* Name: golang.org/x/text
* Version: v0.18.0
* License: [BSD-3-Clause](https://cs.opensource.google/go/x/text/+/v0.18.0:LICENSE)
* Version: v0.21.0
* License: [BSD-3-Clause](https://cs.opensource.google/go/x/text/+/v0.21.0:LICENSE)

```
Copyright 2009 The Go Authors.
Expand Down Expand Up @@ -3940,8 +3942,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
## google.golang.org/genproto/googleapis/rpc/status

* Name: google.golang.org/genproto/googleapis/rpc/status
* Version: v0.0.0-20240903143218-8af14fe29dc1
* License: [Apache-2.0](https://github.com/googleapis/go-genproto/blob/8af14fe29dc1/googleapis/rpc/LICENSE)
* Version: v0.0.0-20241209162323-e6fa225c2576
* License: [Apache-2.0](https://github.com/googleapis/go-genproto/blob/e6fa225c2576/googleapis/rpc/LICENSE)

```
Expand Down Expand Up @@ -4152,8 +4154,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
## google.golang.org/grpc

* Name: google.golang.org/grpc
* Version: v1.66.0
* License: [Apache-2.0](https://github.com/grpc/grpc-go/blob/v1.66.0/LICENSE)
* Version: v1.68.1
* License: [Apache-2.0](https://github.com/grpc/grpc-go/blob/v1.68.1/LICENSE)

```
Expand Down Expand Up @@ -4364,8 +4366,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
## google.golang.org/protobuf

* Name: google.golang.org/protobuf
* Version: v1.34.2
* License: [BSD-3-Clause](https://github.com/protocolbuffers/protobuf-go/blob/v1.34.2/LICENSE)
* Version: v1.35.2
* License: [BSD-3-Clause](https://github.com/protocolbuffers/protobuf-go/blob/v1.35.2/LICENSE)

```
Copyright (c) 2018 The Go Authors. All rights reserved.
Expand Down
2 changes: 2 additions & 0 deletions Third_Party_Code/github.com/hashicorp/yamux/LICENSE
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Copyright (c) 2014 HashiCorp, Inc.

Mozilla Public License, version 2.0

1. Definitions
Expand Down
13 changes: 13 additions & 0 deletions Third_Party_Code/github.com/tmunzer/mistapi-go/mistapi/NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright 2024 Juniper Networks, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
132 changes: 132 additions & 0 deletions docs/guides/release_note_0.2.12.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
---
subcategory: "Release Notes"
page_title: "v0.2.12"
description: |-
Release Notes for v0.2.12
---

# Release Notes for v0.2.12

**version** : v0.2.12
**release date** : December 13th, 2024

!> This release may generate multiple changes to the `org_wlan_resource` and `site_wlan_resource` resources during the first configuration sync. This is due to the new default values defined, and will not impact to actual SSID configuration deployed on the Access Points

## Changes
### WLAN resources default values
Changes applied to `org_wlan_resource` and `site_wlan_resource` to reduce configuration drift when saving the WLAN from the Mist UI. These changes try to mimic the Mist UI default values, however, some of them are changing based on other parameter values which make it currently impossible to completely eliminate the configuration drift.

List of the default value changes:
| Attribute | Previous Default | New Default |
| --------- | ----------- | ---------------- |
| `acct_servers` | not set | `types.ListValueMust(AcctServersValue{}.Type(ctx), []attr.Value{})` |
| `airwatch.api_key` | not set | `""` |
| `airwatch.console_url` | not set | `""` |
| `airwatch.password` | not set | `""` |
| `airwatch.username` | not set | `""` |
| `airwatch` | not set | `types.ObjectValueMust(AirwatchValue{}.AttributeTypes(ctx), ... )` |
| `ap_ids` | `types.ListValueMust(AcctServersValue{}.Type(ctx), []attr.Value{})` | `types.ListNull(types.StringType)` |
| `app_limit` | not set | `types.ObjectValueMust(AppLimitValue{}.AttributeTypes(ctx), ... )` |
| `app_limit` | not set | `types.ObjectValueMust(AppQosValue{}.AttributeTypes(ctx), ... )` |
| `auth.anticlog_threshold` | `16` | removed |
| `auth.keys` | not set | `types.ListValueMust(types.StringType, []attr.Value{types.StringValue(""),types.StringValue(""),types.StringValue(""),types.StringValue(""),})` |
| `auth.owe` | `"disabled"` | removed |
| `auth.wep_as_secondary_auth` | `false` | removed |
| `auth_servers` | not set | `types.ListValueMust(AcctServersValue{}.Type(ctx), []attr.Value{})` |
| `auth_servers_nas_id` | not set | `""` |
| `auth_servers_nas_ip` | not set | `""` |
| `bonjour` | not set | `types.ObjectValueMust(BonjourValue{}.AttributeTypes(ctx), ... )` |
| `cisco_cwa` | not set | `types.ObjectValueMust(CiscoCwaValue{}.AttributeTypes(ctx), ... )` |
| `client_limit_down` | not set | `1000` |
| `client_limit_up` | not set | `512` |
| `coa_servers` | not set | `types.ListValueMust(CoaServersValue{}.Type(ctx), []attr.Value{})` |
| `disable_when_gateway_unreachable` | `false` | removed |
| `disable_when_mxtunnel_down` | `false` | removed |
| `dns_server_rewrite` | not set | `types.ObjectValueMust(DnsServerRewriteValue{}.AttributeTypes(ctx), ... )` |
| `hotspot20` | not set | `types.ObjectValueMust(Hotspot20Value{}.AttributeTypes(ctx), ... )` |
| `mist_nac` | not set | `types.ObjectValueMust(MistNacValue{}.AttributeTypes(ctx), ... )` |
| `mxtunnel_ids` | `types.ListValueMust(types.StringType, []attr.Value{})` | `types.ListNull(types.StringType)` |
| `mxtunnel_name` | `types.ListValueMust(types.StringType, []attr.Value{})` | `types.ListNull(types.StringType)` |
| `portal.allow_wlan_id_roam` | `false` | removed |
| `portal.amazon_email_domains` | `types.ListValueMust(types.StringType, []attr.Value{})` | `types.ListNull(types.StringType)` |
| `portal.broadnet_sid` | `"MIST"` | removed |
| `portal.broadnet_user_id` | `""` | removed |
| `portal.clickatell_api_key` | `""` | removed |
| `portal.cross_site` | `false` | removed |
| `portal.facebook_email_domains` | `types.ListValueMust(types.StringType, []attr.Value{})` | `types.ListNull(types.StringType)` |
| `portal.google_email_domains` | `types.ListValueMust(types.StringType, []attr.Value{})` | `types.ListNull(types.StringType)` |
| `portal.gupshup_password` | `""` | removed |
| `portal.gupshup_userid` | `""` | removed |
| `portal.microsoft_email_domains` | `types.ListValueMust(types.StringType, []attr.Value{})` | `types.ListNull(types.StringType)` |
| `portal.puzzel_password` | `""` | removed |
| `portal.puzzel_service_id` | `""` | removed |
| `portal.puzzel_username` | `""` | removed |
| `portal.sponsor_auto_approve` | `false` | removed |
| `portal.telstra_client_id` | `""` | removed |
| `portal.telstra_client_secret` | `""` | removed |
| `portal.twilio_auth_token` | `""` | removed |
| `portal.twilio_phone_number` | `""` | removed |
| `portal.twilio_sid` | `""` | removed |
| `portal`| not set | `types.ObjectValueMust(PortalValue{}.AttributeTypes(ctx), ... )` |
| `qos`| not set | `types.ObjectValueMust(ObjectValueMust{}.AttributeTypes(ctx), ... )` |
| `radsec`| not set | `types.ObjectValueMust(RadsecValue{}.AttributeTypes(ctx), ... )` |
| `rateset`| not set | `types.MapValueMust(RatesetValue{}.AttributeTypes(ctx), ... )` |
| `reconnect_clients_when_roaming_mxcluster`| `false`  | removed |
| `schedule`| not set | `types.ObjectValueMust(ScheduleValue{}.AttributeTypes(ctx), ... )` |
| `vlan_ids`| not set | `types.ListValueMust(types.StringType, []attr.Value{})` |
| `wlan_limit_down` | not set | `20000` |
| `wlan_limit_up` | not set | `10000` |

### WLAN resources validators
Validators applied to the WLAN resources attributes have been updates to simplify the resource configuration and improve the configuration validity.

List of the validator changes:
| Attribute | Previous Default | New Default |
| --------- | ----------- | ---------------- |
| `acct_servers` | `listvalidator.SizeAtLeast(1)` | removed |
| `airwatch.api_key` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("enabled"), types.BoolValue(true))` |
| `airwatch.console_url` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("enabled"), types.BoolValue(true))` |
| `airwatch.password` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("enabled"), types.BoolValue(true))` |
| `airwatch.username` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("enabled"), types.BoolValue(true))` |
| `auth.key_idx` | `mistvalidator.AllowedWhenValueIs(path.MatchRelative().AtParent().AtName("type"), types.StringValue("wep"))` | `int64validator.Between(1, 4)` |
| `auth.keys` | `mistvalidator.AllowedWhenValueIs(path.MatchRelative().AtParent().AtName("type"), types.StringValue("wep"))` | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("type"), types.StringValue("wep"))` |
| `auth_servers` | `listvalidator.SizeAtLeast(1)` | removed |
| `dynamic_vlan` | `mistvalidator.CannotBeTrueWhenValueIs(path.MatchRoot("vlan_enabled"), types.BoolValue(true))` | `mistvalidator.CanOnlyTrueWhenValueIs(path.MatchRoot("vlan_enabled"), types.BoolValue(true)), boolvalidator.Any( mistvalidator.CanOnlyTrueWhenValueIs(path.MatchRoot("auth").AtName("enable_mac_auth"), types.BoolValue(true)), mistvalidator.CanOnlyTrueWhenValueIs(path.MatchRoot("auth").AtName("type"), types.StringValue("eap")), mistvalidator.CanOnlyTrueWhenValueIs(path.MatchRoot("auth").AtName("type"), types.StringValue("eap192")))` |
| `portal.azure_client_id` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("azure_enabled"), types.BoolValue(true))` |
| `portal.azure_client_secret` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("azure_enabled"), types.BoolValue(true))` |
| `portal.azure_tenant_id` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("azure_enabled"), types.BoolValue(true))` |
| `portal.broadnet_password` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("broadnet"))` |
| `portal.broadnet_sid` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("broadnet"))` |
| `portal.broadnet_user_id` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("broadnet"))` |
| `portal.clickatell_api_key` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("clickatell"))` |
| `portal.external_portal_url` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("auth"), types.StringValue("external"))` |
| `portal.facebook_client_id` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("facebook_enabled"), types.BoolValue(true))` |
| `portal.facebook_client_secret` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("facebook_enabled"), types.BoolValue(true))` |
| `portal.forward_url` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("forward"), types.BoolValue(true))` |
| `portal.gupshup_password` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("gupshup"))` |
| `portal.gupshup_userid` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("gupshup"))` |
| `portal.password` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("passphrase_enabled"), types.BoolValue(true))` |
| `portal.puzzel_password` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("puzzel"))` |
| `portal.puzzel_service_id` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("puzzel"))` |
| `portal.puzzel_username` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("puzzel"))` |
| `portal.sms_provider` | `stringvalidator.OneOf("", "broadnet", "clickatell", "gupshup", "manual", "puzzel", "telstra", "twilio")` | `stringvalidator.OneOf("", "broadnet", "clickatell", "gupshup", "manual", "puzzel", "telstra", "twilio"), mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_enabled"), types.BoolValue(true))` |
| `portal.sso_idp_cert` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("auth"), types.StringValue("sso"))` |
| `portal.sso_idp_sso_url` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("auth"), types.StringValue("sso"))` |
| `portal.sso_issuer` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("auth"), types.StringValue("sso"))` |
| `portal.telstra_client_id` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("telstra"))` |
| `portal.telstra_client_secret` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("telstra"))` |
| `portal.twilio_auth_token` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("telstra"))` |
| `portal.twilio_phone_number` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("twilio"))` |
| `portal.twilio_sid` | not set | `mistvalidator.RequiredWhenValueIs(path.MatchRelative().AtParent().AtName("sms_provider"), types.StringValue("twilio"))` |
| `vlan_ids`| `listvalidator.ValueStringsAre(stringvalidator.Any(mistvalidator.ParseInt(1, 4094), mistvalidator.ParseVar())),` | `listvalidator.ValueStringsAre(stringvalidator.Any(mistvalidator.ParseInt(1, 4094), mistvalidator.ParseVar())),mistvalidator.RequiredWhenValueIs(path.MatchRoot("vlan_pooling"), types.BoolValue(true))` |
| `vlan_pooling` | not set | `mistvalidator.CanOnlyTrueWhenValueIs(path.MatchRoot("vlan_enabled"), types.BoolValue(true))` |

### Remove Attributes
| Attribute | Reason |
| --------- | ----------- |
| `dynamic_psk.vlan_ids` | OpenAPI Specification issue. This attribute is not supported by the Mist API |
| `portal_template_url` | Read Only attribute returned by the Mist API. The returned URL has limited lifetime so it doesn't make sense to store it in the resource state |
| `thumbnail` | Read Only attribute returned by the Mist API. The returned URL has limited lifetime so it doesn't make sense to store it in the resource state |

## Fixes
* [Issue 63](https://github.com/Juniper/terraform-provider-mist/issues/63): Adding `Optional` type to `alarmtemplate.rules.delivery`to fix synchronisation issue
Loading

0 comments on commit c498c96

Please sign in to comment.