Merge pull request #114 from turbot/release/v1.0.0

Release/v1.0.0

Author: cbruno10

CHANGELOG.md

@@ -1,3 +1,28 @@
+## v1.0.0 (2024-10-22)
+
+The following changes have been made for all sample mods:
+
+_Breaking changes_
+
+- Flowpipe v1.0.0 is now required. For a full list of CLI changes, please see the [Flowpipe v1.0.0 CHANGELOG](https://flowpipe.io/changelog/flowpipe-cli-v1-0-0).
+- In Flowpipe configuration files (`.fpc`), `credential` and `credential_import` resources have been renamed to `connection` and `connection_import` respectively.
+- Updated the following param types:
+  - `approvers`: `list(string)` to `list(notifier)`.
+  - `database`: `string` to `connection.steampipe`.
+  - `notifier`: `string` to `notifier`.
+- Updated the following variable types:
+  - `approvers`: `list(string)` to `list(notifier)`.
+  - `database`: `string` to `connection.steampipe`.
+  - `notifier`: `string` to `notifier`.
+- Renamed `cred` param to `conn` and updated its type from `string` to `conn`.
+
+_Enhancements_
+
+- Added `sample` to each mod's categories.
+- Updated the following pipeline tags:
+  - `type = "featured"` to `recommended = "true"`
+- Added `format` to params and variables that use multiline and JSON strings.
+
 ## v0.4.1 [2024-03-05]
 
 _Bug fixes_

README.md

@@ -48,7 +48,7 @@ Run a pipeline:
 flowpipe pipeline run http_list_pagination
 ```
 
-Some mods require [credentials](https://flowpipe.io/docs/run/credentials) and [variables](https://flowpipe.io/docs/build/mod-variables), please see each mod's README.md for specific instructions.
+Some mods require [connections](https://flowpipe.io/docs/run/connections) and [variables](https://flowpipe.io/docs/build/mod-variables), please see each mod's README.md for specific instructions.
 
 ## Open Source & Contributing
 

access_management/add_new_user_in_microsoft_office_365/README.md

@@ -24,7 +24,7 @@ cd access_management/add_new_user_in_microsoft_office_365
 flowpipe mod install
 ```
 
-## Credentials
+## Connections
 
 By default, the following environment variables will be used for authentication:
 
@@ -33,14 +33,14 @@ By default, the following environment variables will be used for authentication:
 - `JIRA_USER`
 - `TEAMS_ACCESS_TOKEN`
 
-You can also create `credential` resources in configuration files:
+You can also create `connection` resources in configuration files:
 
 ```sh
 vi ~/.flowpipe/config/jira.fpc
 ```
 
 ```hcl
-credential "jira" "default" {
+connection "jira" "default" {
   base_url    = "https://test.atlassian.net/"
   api_token   = "ATATT3........."
   username    = "abc@email.com"
@@ -52,26 +52,29 @@ vi ~/.flowpipe/config/teams.fpc
 ```
 
 ```hcl
-credential "teams" "default" {
+connection "teams" "default" {
   access_token = "<access_token>"
 }
 ```
 
-For more information on credentials in Flowpipe, please see [Managing Credentials](https://flowpipe.io/docs/run/credentials).
+For more information on connections in Flowpipe, please see [Managing Connections](https://flowpipe.io/docs/run/connections).
 
 ## Usage
 
 Run the pipeline and specify the `teams_display_name`, `teams_account_enabled`, `teams_mail_nickname`, `teams_user_principal_name`, `teams_password`, `teams_license_sku_ids`, `jira_project_key`, `teams_team_id` and `teams_message` pipeline arguments:
 
 ```sh
 flowpipe pipeline run add_new_user_in_microsoft_office_365 \
-  --arg teams_display_name='John Doe' \
-  --arg teams_account_enabled=true \
-  --arg teams_mail_nickname='john.doe' \
-  --arg teams_user_principal_name='john.doe@foo.com' \
-  --arg teams_password='P@ssw0rd' \
-  --arg teams_license_sku_ids='["<license_sku_id>"]' \
-  --arg jira_project_key='project-foo' \
-  --arg teams_team_id='<team_id>' \
-  --arg teams_message='New user created'
+  --arg 'teams_display_name=Hero me2' \
+  --arg 'teams_account_enabled=true' \
+  --arg 'teams_mail_nickname=hero.meee' \
+  --arg 'teams_user_principal_name=testfp5@turbotad.onmicrosoft.com' \
+  --arg 'teams_password=P@ssw0rd' \
+  --arg 'teams_license_sku_ids=["6470687e-a428-4b7a-bef2-8a291ad947c9"]' \
+  --arg 'jira_project_key=TEST' \
+  --arg 'jira_issue_type=Task' \
+  --arg 'teams_team_id=f137966a-52be-4c32-a28f-9665634ba181' \
+  --arg 'teams_roles=["member"]' \
+  --arg 'teams_message_content_type=text' \
+  --arg 'teams_message=New user created'
 ```

access_management/add_new_user_in_microsoft_office_365/add_new_user_in_microsoft_office_365.fp

@@ -3,24 +3,29 @@ pipeline "add_new_user_in_microsoft_office_365" {
   description = "Add a new user in Microsoft Office 365."
 
   tags = {
-    type = "featured"
+    recommended = "true"
   }
 
-  param "jira_cred" {
-    type        = string
-    description = "Name for Jira credentials to use. If not provided, the default credentials will be used."
-    default     = "default"
+  param "jira_conn" {
+    type        = connection.jira
+    description = "Name of Jira connection to use. If not provided, the default Jira connection will be used."
+    default     = connection.jira.default
   }
 
   param "jira_project_key" {
     type        = string
     description = "The key identifying the Jira project."
   }
 
-  param "teams_cred" {
+  param "jira_issue_type" {
     type        = string
-    description = "Name for Teams credentials to use. If not provided, the default credentials will be used."
-    default     = "default"
+    description = "The issue type the Jira project."
+  }
+
+  param "teams_conn" {
+    type        = connection.teams
+    description = "Name of Teams connection to use. If not provided, the default Teams connection will be used."
+    default     = connection.teams.default
   }
 
   param "teams_display_name" {
@@ -48,6 +53,16 @@ pipeline "add_new_user_in_microsoft_office_365" {
     description = "The password for the user."
   }
 
+  param "teams_chat_type" {
+    type        = string
+    description = "Specifies the type of chat."
+  }
+
+  param "teams_message_content_type" {
+    type        = string
+    description = "The type of the content. Possible values are text and html."
+  }
+
   param "teams_license_sku_ids" {
     type        = list(string)
     description = "The unique identifier for the available licenses."
@@ -60,7 +75,6 @@ pipeline "add_new_user_in_microsoft_office_365" {
 
   param "teams_roles" {
     type        = list(string)
-    default     = ["member"] // or "owner" or other applicable roles
     description = "The roles for the user."
   }
 
@@ -73,7 +87,7 @@ pipeline "add_new_user_in_microsoft_office_365" {
   step "pipeline" "create_user" {
     pipeline = teams.pipeline.create_user
     args = {
-      cred                = param.teams_cred
+      conn                = param.teams_conn
       password            = param.teams_password
       user_principal_name = param.teams_user_principal_name
       mail_nickname       = param.teams_mail_nickname
@@ -87,22 +101,22 @@ pipeline "add_new_user_in_microsoft_office_365" {
     depends_on = [step.pipeline.create_user]
     pipeline   = teams.pipeline.assign_licenses_to_user
     args = {
-      cred    = param.teams_cred
+      conn    = param.teams_conn
       sku_ids = param.teams_license_sku_ids
       user_id = param.teams_user_principal_name
     }
   }
 
   # Create JIRA issue
   step "pipeline" "create_issue" {
-    depends_on = [step.pipeline.assign_licenses_to_user]
+    depends_on = [step.pipeline.create_user]
     pipeline   = jira.pipeline.create_issue
     args = {
-      cred        = param.jira_cred
+      conn        = param.jira_conn
       project_key = param.jira_project_key
       summary     = "Add a new user: ${step.pipeline.create_user.output.user.userPrincipalName}"
       description = jsonencode(step.pipeline.create_user.output.user)
-      issue_type  = "New Feature"
+      issue_type  = param.jira_issue_type
     }
   }
 
@@ -111,7 +125,7 @@ pipeline "add_new_user_in_microsoft_office_365" {
     depends_on = [step.pipeline.create_issue]
     pipeline   = teams.pipeline.add_team_member
     args = {
-      cred    = param.teams_cred
+      conn    = param.teams_conn
       team_id = param.teams_team_id
       user_id = param.teams_user_principal_name
       roles   = param.teams_roles
@@ -123,8 +137,8 @@ pipeline "add_new_user_in_microsoft_office_365" {
     depends_on = [step.pipeline.add_team_member]
     pipeline   = teams.pipeline.create_chat
     args = {
-      cred      = param.teams_cred
-      chat_type = "oneOnOne"
+      conn      = param.teams_conn
+      chat_type = param.teams_chat_type
       user_ids  = ["${param.teams_user_principal_name}"]
     }
   }
@@ -134,9 +148,10 @@ pipeline "add_new_user_in_microsoft_office_365" {
     depends_on = [step.pipeline.create_chat]
     pipeline   = teams.pipeline.send_chat_message
     args = {
-      cred    = param.teams_cred
-      chat_id = step.pipeline.create_chat.output.chat.id
-      message = param.teams_message
+      conn                 = param.teams_conn
+      chat_id              = step.pipeline.create_chat.output.chat.id
+      message              = param.teams_message
+      message_content_type = param.teams_message_content_type
     }
   }
 }

access_management/add_new_user_in_microsoft_office_365/mod.fp

@@ -2,15 +2,18 @@ mod "add_new_user_in_microsoft_office_365" {
   title         = "Add New User in Microsoft Office 365"
   description   = "Add a new user in Microsoft Office 365."
   documentation = file("./README.md")
-  categories    = ["access management"]
+  categories    = ["access management", "sample"]
 
   require {
+    flowpipe {
+      min_version = "1.0.0"
+    }
     mod "github.com/turbot/flowpipe-mod-teams" {
-      version = "0.1.0"
+      version = "^1"
     }
 
     mod "github.com/turbot/flowpipe-mod-jira" {
-      version = "0.1.0"
+      version = "^1"
     }
   }
 }

access_management/create_okta_user_assign_to_group/README.md

@@ -24,27 +24,27 @@ cd access_management/create_okta_user_assign_to_group
 flowpipe mod install
 ```
 
-## Credentials
+## Connections
 
 By default, the following environment variables will be used for authentication:
 
 - `OKTA_TOKEN`
 - `OKTA_ORGURL`
 
-You can also create `credential` resources in configuration files:
+You can also create `connection` resources in configuration files:
 
 ```sh
 vi ~/.flowpipe/config/okta.fpc
 ```
 
 ```hcl
-credential "okta" "default" {
+connection "okta" "default" {
   domain    = "https://test.okta.com"
   api_token = "00B63........"
 }
 ```
 
-For more information on credentials in Flowpipe, please see [Managing Credentials](https://flowpipe.io/docs/run/credentials).
+For more information on connections in Flowpipe, please see [Managing Connections](https://flowpipe.io/docs/run/connections).
 
 ## Usage
 

access_management/create_okta_user_assign_to_group/create_okta_user_assign_to_group.fp

@@ -2,10 +2,10 @@ pipeline "create_okta_user_assign_to_group" {
   title       = "Create User Assign Group"
   description = "Create a user and assign it to a group."
 
-  param "okta_cred" {
-    type        = string
-    description = "Name for Okta credentials to use. If not provided, the default credentials will be used."
-    default     = "default"
+  param "conn" {
+    type        = connection.okta
+    description = "Name of Okta connection to use. If not provided, the default Okta connection will be used."
+    default     = connection.okta.default
   }
 
   param "first_name" {
@@ -41,7 +41,7 @@ pipeline "create_okta_user_assign_to_group" {
   step "pipeline" "create_user" {
     pipeline = okta.pipeline.create_user
     args = {
-      cred       = param.okta_cred
+      conn       = param.conn
       first_name = param.first_name
       last_name  = param.last_name
       email      = param.email
@@ -53,7 +53,7 @@ pipeline "create_okta_user_assign_to_group" {
   step "pipeline" "assign_user" {
     pipeline = okta.pipeline.assign_user
     args = {
-      cred     = param.okta_cred
+      conn     = param.conn
       group_id = param.group_id
       user_id  = step.pipeline.create_user.output.user.id
     }
@@ -64,7 +64,7 @@ pipeline "create_okta_user_assign_to_group" {
 
     pipeline = okta.pipeline.list_member_users
     args = {
-      cred     = param.okta_cred
+      conn     = param.conn
       group_id = param.group_id
     }
   }

access_management/create_okta_user_assign_to_group/mod.fp

@@ -2,11 +2,14 @@ mod "create_okta_user_assign_to_group" {
   title         = "Create Okta User and Assign to Group"
   description   = "Create a user in Okta and assign to a group."
   documentation = file("./README.md")
-  categories    = ["access management"]
+  categories    = ["access management", "sample"]
 
   require {
+    flowpipe {
+      min_version = "1.0.0"
+    }
     mod "github.com/turbot/flowpipe-mod-okta" {
-      version = "0.1.0"
+      version = "^1"
     }
   }
 }

access_management/invite_pipes_organization_member/README.md

@@ -26,25 +26,25 @@ cd access_management/invite_pipes_organization_member
 flowpipe mod install
 ```
 
-## Credentials
+## Connections
 
 By default, the following environment variables will be used for authentication:
 
 - `PIPES_TOKEN`
 
-You can also create `credential` resources in configuration files:
+You can also create `connection` resources in configuration files:
 
 ```sh
 vi ~/.flowpipe/config/pipes.fpc
 ```
 
 ```hcl
-credential "pipes" "default" {
+connection "pipes" "default" {
   token = "tpt_..."
 }
 ```
 
-For more information on credentials in Flowpipe, please see [Managing Credentials](https://flowpipe.io/docs/run/credentials).
+For more information on connections in Flowpipe, please see [Managing Connections](https://flowpipe.io/docs/run/connections).
 
 ## Usage