feat: initial aws sagemaker orb (#1)

stiyyagura0901 · web-flow · commit b261bc08b603 · 2023-11-16T15:29:55.000-05:00
* feat: initial aws sagemaker orb
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,31 @@
+version: 2.1
+setup: true
+orbs:
+  orb-tools: circleci/orb-tools@12.0
+  shellcheck: circleci/shellcheck@3.2
+
+filters: &filters
+  tags:
+    only: /.*/
+
+workflows:
+  lint-pack:
+    jobs:
+      - orb-tools/lint:
+          source_dir: src
+          filters: *filters
+      - orb-tools/pack:
+          source_dir: src
+          filters: *filters
+      - orb-tools/review:
+          source_dir: src
+          filters: *filters
+      - shellcheck/check:
+          filters: *filters
+      - orb-tools/continue:
+          orb_name: aws-sagemaker
+          pipeline_number: << pipeline.number >>
+          vcs_type: << pipeline.project.type >>
+          requires:
+            [orb-tools/lint, orb-tools/review, orb-tools/pack, shellcheck/check]
+          filters: *filters
diff --git a/.circleci/test-deploy.yml b/.circleci/test-deploy.yml
@@ -0,0 +1,40 @@
+version: 2.1
+orbs:
+  orb-tools: circleci/orb-tools@12.0
+  aws-sagemaker: {}
+
+filters: &filters
+  tags:
+    only: /.*/
+
+release-filters: &release-filters
+  branches:
+    ignore: /.*/
+  tags:
+    only: /^v[0-9]+\.[0-9]+\.[0-9]+$/
+
+jobs:
+  testing-setup-command:
+    docker:
+      - image: cimg/base:current-22.04
+    steps:
+      - aws-sagemaker/setup
+      - run:
+          name: Verify aws-sagemaker/setup
+          command: which cci-sagemaker
+workflows:
+  test-deploy:
+    jobs:
+      - testing-setup-command:
+          filters: *filters
+      - orb-tools/pack:
+          filters: *release-filters
+      - orb-tools/publish:
+          orb_name: circleci/aws-sagemaker
+          vcs_type: << pipeline.project.type >>
+          pub_type: production
+          requires:
+            - orb-tools/pack
+            - testing-setup-command
+          context: Circleci-Ai-Orb-Publishing
+          filters: *release-filters
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,4 @@
+# Ping these folks when changes are made to this repository
+- @CircleCI-Public/orb-publishers
+
+# We can also add orb-specifc codeowners at some point if desirable
diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
@@ -0,0 +1,13 @@
+---
+name: "\U0001F680 Feature Request"
+about: Propose changes to the orb.
+title: ''
+labels: feature_request
+assignees: ''
+---
+
+## Describe Request:
+
+## Examples:
+
+## Supporting Documentation Links:
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
@@ -0,0 +1,33 @@
+---
+name: "\U0001F41E  Bug report"
+about: Report any bugs encountered while using this orb.
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Orb version:
+
+<!---
+  e.g., 1.0.0
+  find this information in your config.yml file;
+  if the version is @volatile, check the top of your CircleCI-generated,
+  expanded configuration file, viewable from the "Configuration" tab of
+  any job page, for the orb's specific semantic version number
+-->
+
+## What happened:
+
+<!---
+  please include any relevant links to CircleCI workflows or jobs
+  where you saw this behavior
+-->
+
+## Expected behavior:
+
+<!--- what should happen, ideally? -->
+
+## Additional Information:
+
+<!--- Provide any additional context possible. -->
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST.md b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST.md
@@ -0,0 +1,33 @@
+
+**SEMVER Update Type:**
+- [ ] Major
+- [ ] Minor
+- [ ] Patch
+
+## Description:
+
+<!---
+  Describe your changes in detail, preferably in an imperative mood,
+  i.e., "add `commandA` to `jobB`"
+ -->
+
+## Motivation:
+
+<!---
+  Share any open issues this PR references or otherwise describe the motivation to submit this pull request.
+ -->
+
+ **Closes Issues:**
+-  ISSUE URL
+
+## Checklist:
+
+<!--
+	Thank you for contributing to CircleCI Orbs!
+	before submitting your a request, please go through the following
+	items and place an x in the [ ] if they have been completed
+-->
+
+- [ ] All new jobs, commands, executors, parameters have descriptions.
+- [ ] Usage Example version numbers have been updated.
+- [ ] Changelog has been updated.
diff --git a/README.md b/README.md
@@ -1 +1,30 @@
 # aws-sagemaker-orb
+
+🚧 NOTE: This repo is under construction and not for use yet 🚧
+
+# AWS Sagemaker Orb [![CircleCI Build Status](https://circleci.com/gh/CircleCI-Public/aws-sagemaker-orb.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/CircleCI-Public/aws-sagemaker-orb) [![CircleCI Orb Version](https://badges.circleci.com/orbs/circleci/aws-sagemaker.svg)](https://circleci.com/orbs/registry/orb/circleci/aws-sagemaker) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/circleci-public/aws-sagemaker-orb/main/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)
+
+This repository has the code for the the CircleCI [AWS Sagemaker Orb](https://github.com/CircleCI-Public/aws-sagemaker-orb). Please note that this version is currently in beta. Explore, understand, and experiment, but proceed with caution when integrating it into practical applications. 🛠✨
+
+## Usage
+
+### Setup
+
+In order to use the AWS Sagemaker Orb on CircleCI you will need to setup environment variables either in context or project env vars. Required variables are SAGEMAKER_EXECUTION_ROLE_ARN.
+This Orb uses the circleci provided job token called CIRCLE_OIDC_TOKEN to get authenticated with your AWS sagemaker service.
+
+### Use In Config
+
+For full usage guidelines, see the [Orb Registry listing](http://circleci.com/orbs/registry/orb/circleci/aws-sagemaker).
+
+---
+
+## FAQ
+
+View the [FAQ in the wiki](https://github.com/CircleCI-Public/aws-sagemaker-orb/wiki/FAQ)
+
+## Contributing
+
+We welcome [issues](https://github.com/CircleCI-Public/aws-sagemaker-orb/issues) to and [pull requests](https://github.com/CircleCI-Public/aws-sagemaker-orb/pulls) against this repository!
+
+For further questions/comments about this or other orbs, visit [CircleCI's orbs discussion forum](https://discuss.circleci.com/c/orbs).
diff --git a/src/.gitignore b/src/.gitignore
@@ -0,0 +1,3 @@
+# orb.yml is "packed" from source, and not published directly from the repository.
+orb.yml
+.DS_Store
diff --git a/src/.yamllint b/src/.yamllint
@@ -0,0 +1,6 @@
+extends: relaxed
+
+rules:
+    line-length:
+        max: 200
+        allow-non-breakable-inline-mappings: true
diff --git a/src/@orb.yml b/src/@orb.yml
@@ -0,0 +1,8 @@
+version: 2.1
+
+description: >
+  Orb for deploying models to AWS sagemaker and tracking releases in CircleCI
+
+display:
+  home_url: "https://github.com/CircleCI-Public/aws-sagemaker-orb/wiki"
+  source_url: "https://github.com/CircleCI-Public/aws-sagemaker-orb"
diff --git a/src/LICENSE b/src/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 <organization>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/src/README.md b/src/README.md
@@ -0,0 +1,26 @@
+# Orb Source
+
+Orbs are shipped as individual `orb.yml` files, however, to make development easier, it is possible to author an orb in _unpacked_ form, which can be _packed_ with the CircleCI CLI and published.
+
+The default `.circleci/config.yml` file contains the configuration code needed to automatically pack, test, and deploy any changes made to the contents of the orb source in this directory.
+
+## @orb.yml
+
+This is the entry point for our orb "tree", which becomes our `orb.yml` file later.
+
+Within the `@orb.yml` we generally specify 4 configuration keys
+
+**Keys**
+
+1. **version**
+    Specify version 2.1 for orb-compatible configuration `version: 2.1`
+2. **description**
+    Give your orb a description. Shown within the CLI and orb registry
+3. **display**
+    Specify the `home_url` referencing documentation or product URL, and `source_url` linking to the orb's source repository.
+4. **orbs**
+    (optional) Some orbs may depend on other orbs. Import them here.
+
+## See:
+ - [Orb Author Intro](https://circleci.com/docs/2.0/orb-author-intro/#section=configuration)
+ - [Reusable Configuration](https://circleci.com/docs/2.0/reusing-config)
diff --git a/src/commands/create_model.yml b/src/commands/create_model.yml
@@ -0,0 +1,27 @@
+description: >
+  This command creates a sagemaker model with latest model package.
+parameters:
+  model_name:
+    description: Model name
+    type: string
+  region_name:
+    description: AWS region name
+    type: string
+    default: us-east-1
+  bucket:
+    description: S3 bucket for the model
+    type: string
+  pipeline_id:
+    description: CircleCI pipeline ID
+    type: string
+steps:
+  - run:
+      name: Create a model
+      description: create a model for inference
+      environment:
+        MODEL_NAME: << parameters.model_name >>
+        CIRCLE_PIPELINE_ID: << parameters.pipeline_id >>
+        S3_BUCKET_NAME: << parameters.bucket >>
+        REGION_NAME: << parameters.region_name >>
+      command: |
+        cci-sagemaker sagemaker create-model
diff --git a/src/commands/deploy_endpoint.yml b/src/commands/deploy_endpoint.yml
@@ -0,0 +1,38 @@
+description: >
+  This command deploys inference endpoint by create or update
+parameters:
+  model_name:
+    description: Model name
+    type: string
+  bucket:
+    description: S3 bucket for the model
+    type: string
+  model_desc:
+    description: sagemaker model desription
+    type: string
+  deploy_environment:
+    description: Deploy ENV
+    type: string
+  pipeline_id:
+    description: CircleCI pipeline ID
+    type: string
+  project_id:
+    description: CircleCI project ID
+    type: string
+  region_name:
+    description: AWS region name
+    type: string
+steps:
+  - run:
+      name: Create or Update endpoint
+      description: create or update endpoint with new model
+      environment:
+        MODEL_NAME: << parameters.model_name >>
+        MODEL_DESC: << parameters.model_desc >>
+        DEPLOY_ENVIRONMENT: << parameters.deploy_environment >>
+        CIRCLE_PIPELINE_ID: << parameters.pipeline_id >>
+        CIRCLE_PROJECT_ID: << parameters.project_id >>
+        S3_BUCKET_NAME: << parameters.bucket >>
+        REGION_NAME: << parameters.region_name >>
+      command: |
+        cci-sagemaker sagemaker upsert-endpoint
diff --git a/src/commands/deploy_endpoint_configuration.yml b/src/commands/deploy_endpoint_configuration.yml
@@ -0,0 +1,41 @@
+description: >
+  This command creates an create an endpoint configuration.
+parameters:
+  model_name:
+    description: Model name
+    type: string
+  region_name:
+    description: AWS region name
+    type: string
+    default: us-east-1
+  bucket:
+    description: S3 bucket for the model
+    type: string
+  deploy_environment:
+    description: Deploy ENV
+    type: string
+  pipeline_id:
+    description: CircleCI pipeline ID
+    type: string
+  endpoint_instance_type:
+    description: EC2 instance type to run endpoint inference
+    type: string
+    default: "ml.t2.medium"
+  endpoint_instance_count:
+    description: Number of instances to run endpoint inference
+    type: integer
+    default: 1
+steps:
+  - run:
+      name: Create Endpoint Configuration
+      description: create an endpoint configuration
+      environment:
+        MODEL_NAME: << parameters.model_name >>
+        DEPLOY_ENVIRONMENT: << parameters.deploy_environment >>
+        CIRCLE_PIPELINE_ID: << parameters.pipeline_id >>
+        S3_BUCKET_NAME: << parameters.bucket >>
+        REGION_NAME: << parameters.region_name >>
+        ENDPOINT_INSTANCE_TYPE: << parameters.endpoint_instance_type >>
+        ENDPOINT_INSTANCE_COUNT: << parameters.endpoint_instance_count >>
+      command: |
+        cci-sagemaker sagemaker create-endpoint-configuration
diff --git a/src/commands/setup.yml b/src/commands/setup.yml
@@ -0,0 +1,6 @@
+description: >
+  This command downloads the sagemaker cli binary.
+steps:
+  - run:
+      name: Download cci-sagemaker binary
+      command: <<include(scripts/main.sh)>>
diff --git a/src/examples/create_endpoint.yml b/src/examples/create_endpoint.yml
diff --git a/src/jobs/create_model.yml b/src/jobs/create_model.yml
diff --git a/src/jobs/deploy_endpoint.yml b/src/jobs/deploy_endpoint.yml
diff --git a/src/jobs/deploy_endpoint_configuration.yml b/src/jobs/deploy_endpoint_configuration.yml
diff --git a/src/scripts/main.sh b/src/scripts/main.sh

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# orb.yml is "packed" from source, and not published directly from the repository.`
	`2`	`+orb.yml`
	`3`	`+.DS_Store`