Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance documentation clarity for JSON field inputs for the ECS work pool and ideally across other work pool types #13268

Open
2 tasks done
taylor-curran opened this issue May 7, 2024 · 0 comments
Labels
docs needs:triage Needs feedback from the Prefect product team

Comments

@taylor-curran
Copy link
Contributor

taylor-curran commented May 7, 2024

First check

  • I added a descriptive title to this issue.
  • I used GitHub search to find a similar request and didn't find it 馃槆

Describe the issue

When a user goes in to add network connection information to their ECS worker, the UX is like:
image

When they click on the link to aws docs they are given the following JSON example:

{
  "AssignPublicIp" : String,
  "SecurityGroups" : [ String, ... ],
  "Subnets" : [ String, ... ]
}

^Notice a capital S for Subnets.

However, further research into AWS docs led me to

If you are defining ECS services in a CloudFormation template, use "Subnets". If you are using the Boto3 client, use "subnets".

With respect to the Prefect ECS work pool, we employ boto3. The request that is happening under the hood is RunTask, so a lowercase s is used.

  "networkConfiguration": { 
     "awsvpcConfiguration": { 
        "assignPublicIp": "string",
        "securityGroups": [ "string" ],
        "subnets": [ "string" ]
     }
  },

The following worked for the user after extensive trial and error:

{"awsvpcConfiguration":{"subnets":["subnet-xx","subnet-xx"],"assignPublicIp":"DISABLED"}}

While adding the following addition to the base job template:

      "launchType": "{{ launch_type }}",
      "taskDefinition": "{{ task_definition_arn }}",
      "networkConfiguration": "{{ network_configuration }}"

Describe the proposed change

Ideally the in-UI and external documentation makes it clearer what should be included in each text/JSON block. We recommend enhancing documentation clarity for JSON field inputs across all work pool types by providing precise examples that reflect the required API or framework and aligning field names with their actual API counterparts, ensuring correct casing and format. This will help ensure accuracy and improve user experience.

Additional context

No response

@taylor-curran taylor-curran added docs needs:triage Needs feedback from the Prefect product team labels May 7, 2024
@taylor-curran taylor-curran changed the title Correct or add network configuration docs for ECS work pool Enhance Documentation Clarity for JSON Field Inputs for the ECS work pool and ideally across other Work Pool Types May 7, 2024
@taylor-curran taylor-curran changed the title Enhance Documentation Clarity for JSON Field Inputs for the ECS work pool and ideally across other Work Pool Types Enhance documentation clarity for JSON field inputs for the ECS work pool and ideally across other work pool types May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs needs:triage Needs feedback from the Prefect product team
Projects
None yet
Development

No branches or pull requests

1 participant