You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@ciflex/ciflexctl

Package Overview
Dependencies
Maintainers
0
Versions
59
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ciflex/ciflexctl


Version published
Weekly downloads
18K
decreased by-5.57%
Maintainers
0
Created
Weekly downloads
 

Readme

Source

Welcome to CiFlex CICD Platform

The CiFlex CICD Platform is an AWS CodePipeline generator, streamlining pipeline creation by simplifying configuration for tasks such as building, unit testing, code style linting, and deploying. It's a fully managed continuous delivery service that automates AWS CodePipeline infrastructure, empowering DevOps teams to efficiently manage and automate their pipeline processes. With CiFlex, DevOps teams can create and publish plugins to introduce new features, enabling application teams to easily enhance their CICD workflows.

Benefits of CiFlex CICD Platform:

  • Self-Mutating CICD Pipeline: CiFlex plugins can be dynamically added, updated with new values, or removed without coding, enabling a pipeline to reconfigure itself to deploy new or updated stages. Pipelines will automatically update based on configuration files submitted by application teams.

  • Plugin-Based Architecture: With a plugin-based architecture, DevOps teams can effortlessly extend functionality by creating or modifying plugins. This empowers application teams to swiftly incorporate new capabilities into their pipelines, adapting to changing requirements with ease.

  • Authorization: CiFlex prioritizes security by leveraging AWS Cognito services to protect its APIs with JSON Web Tokens (JWT). This ensures that application teams must authenticate to create and provision pipelines, guaranteeing secure access and maintaining data integrity.

  • AWS Service Catalog Integration: Streamline pipeline creation and provisioning with seamless integration into the AWS Service Catalog. Centralize management of pipeline resources to enhance efficiency and governance for application teams.

  • Command-Line Inteface: A unified tool that offers a consistent interface for interacting with CiFlex APIs.

AWS Service Catalog Integration

Dynamically Configure AWS CodePipeline

Usage

export CIFLEX_TOKEN=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

npm config set //npm.pkg.github.com/:_authToken $CIFLEX_TOKEN
npm config set @mrwconsulting:registry https://npm.pkg.github.com/
npm install @ciflex/ciflexctl --global

ciflexctl --help
ciflexctl --version

Prerequisites

Platform Setup

  1. Request CiFlex Token: (email: support@mrwconsulting.tech)

  2. Install CiFlex Platform:

    export AWS_ACCESS_KEY_ID=<AWS_ACCESS_KEY_ID>
    export AWS_SECRET_ACCESS_KEY=<AWS_SECRET_ACCESS_KEY>
    export CIFLEX_TOKEN=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
    
    npm config set //npm.pkg.github.com/:_authToken $CIFLEX_TOKEN
    npm config set @mrwconsulting:registry https://npm.pkg.github.com/
    npm install @ciflex/ciflexctl --global
    
    ciflexctl platform --setup --vpcId <VPC_ID>
    

    Detected vpc id: <VPC_ID>
    Verify toolkit stack...
    Toolkit stack exists..

    ✨ Synthesis time: 7.06s
    stack (ciflex-platform-stack): deploying... [1/1]
    ciflex-platform-stack: creating CloudFormation changeset...

    ✅ stack (ciflex-platform-stack)
    ✨ Deployment time: 309.76s

    Outputs:
    stack.restapiEndpoint7C8BD49C = <https...>
    ✨ Total time: 325.35s

    Do you want to install cognito admin account? [y/N]y
    Enter cognito username: [admin]
    Enter cognito email: [support@mrwconsulting.tech]
    Enter cognito password: [Password01!]

    Cognito account configured: <arn...>
    Do you want to load default plugins? [y/N]y
    Creating dynamodb table: ciflex-registry
    Loading default plugins...

    Do you want to initialize catalog repository? [y/N]y

    ✨ Synthesis time: 5.32s

    ciflex-catalog-stack: deploying... [1/1]
    ciflex-catalog-stack: creating CloudFormation changeset...

    ✅ ciflex-catalog-stack
    ✨ Deployment time: 56.37s

    Stack ARN: <arn...>
    ✨ Total time: 61.69s

    Catalog repository initialized...

Pipeline Samples

  1. Clone the Git repository containing pipeline samples: (https://github.com/mrwconsulting/CiFlex-Samples.git)

  2. Provision application pipeline:

    export AWS_ACCESS_KEY_ID=<AWS_ACCESS_KEY_ID>
    export AWS_SECRET_ACCESS_KEY=<AWS_SECRET_ACCESS_KEY>
    
    cd springboot-maven
    ../bin/access-token.sh 
    export CIFLEX_ACCESS_TOKEN=<CIFLEX_ACCESS_TOKEN>
    ciflexctl pipeline --deploy
    

FAQ

Q. What are the environment variables used to configure CiFlexctl?
A. Here are a few common ones. See the documentation for more details.




Q. Can we add our own stages and steps?
A. Certainly! You can add your own custom stages \ steps to a pipeline by including them in the YAML file that defines the pipeline. This allows you to tailor the pipeline to your specific requirements and workflows.

Q. Can we create our own plugins or update existing ones?
A. Yes, use ciflexctl

    Q. Can different pipelines be deployed based on a branch in our software development process?
    A. Yes, create pipeline properties file. Here's example:[pipeline.properties]



    Q. How do I disable a pipeline stage?
    A. Both stages and steps can be disabled by setting the 'isActive' attribute to 'false'. Here's an example




    Keywords

    FAQs

    Package last updated on 09 Jul 2024

    Did you know?

    Socket

    Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

    Install

    Related posts

    SocketSocket SOC 2 Logo

    Product

    • Package Alerts
    • Integrations
    • Docs
    • Pricing
    • FAQ
    • Roadmap
    • Changelog

    Packages

    Stay in touch

    Get open source security insights delivered straight into your inbox.


    • Terms
    • Privacy
    • Security

    Made with ⚡️ by Socket Inc