Home

Project GOAT Wiki

Table of Contents

• Introduction
• Goals
• Overview
• Features
• Usage
• Version History
• Contributors
• Resources
• Contact

Introduction

Welcome to the Project GOAT wiki! This wiki serves as the central hub for all things related to the GOAT project, which is a front-end application designed to facilitate communication between Python modules and major Public Cloud Platforms such as GCP, OCI, AWS, and Azure. Not only does this project provide practical value, but the source code also serves as an educational example for using our internal modules and integrating multiple modules into a cohesive app/package.

Goals

Our primary goals with Project GOAT are as follows:

• Develop a versatile and user-friendly front-end application that bridges the gap between Python modules and Public Cloud Platforms.
• Provide a comprehensive example of how to write code using our internal modules.
• Demonstrate effective integration of multiple modules within a single app/package.
• Empower developers to interact with Public Cloud Platforms effortlessly.

Overview

Project GOAT, standing for "goat," embodies the vision of seamless interaction with various Public Cloud Platforms. By leveraging this application, developers can harness the capabilities of Python modules and effortlessly communicate with cloud providers such as GCP, OCI, AWS, and Azure. This project not only enhances cloud integration but also doubles as a valuable learning tool for coding practices and module integration.

Features

• Cross-Platform Compatibility: GOAT supports interaction with GCP, OCI, AWS, and Azure, making it a versatile solution for developers across different platforms.
• Internal Module Showcase: The GOAT codebase serves as an exemplar of utilizing our internal modules effectively, encouraging best coding practices.
• Module Integration: By combining multiple modules into a single application/package, GOAT showcases the art of seamless integration.

Usage

To use GOAT for your cloud platform interactions, follow these steps:

• Installation Instructions

1. Create a virtual environment. We will call it prod:

   python3 -m venv ~/prod

2. Activate virtual environment:

   cd ~/prod && source bin/activate

3. Clone the repo:

   git clone [email protected]:stacksc/goat.git

4. Install all required packages with 1 script from the main repository:

   cd ~/prod/goat && ./bulk.sh --action rebuild --target all

5. Install oci-cli using the latest version:
   a. Mac

   brew install oci-cli

   b. Linux

   bash -c "$(curl -L https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.sh)"

• Configure each API (OCI, AWS, JIRA, SLACK and Jenkins). Feel free to configure/setup only what is necessary.
• Review the README.md for some example usage

Version History

Version 1.0.0

• [Month Day Year] - Initial release
• [Add major features and supported platforms]

Version 1.1.0

• [Month Day Year] - Added support for [specific platform]
• [Month Day Year] - Enhanced [feature]
• [Add more changes and improvements]

Contributors

Meet the talented individuals who have contributed to Project GOAT:

• Christopher Stacks - Python Developer, Engineer, Artist
• [Add more contributors]

Resources

Access valuable resources for Project GOAT:

• Link to GitHub repository
• [API Documentation]
• [Demo Video]
• [Tutorials]
• [Additional resources]

Contact

Questions, suggestions, or collaboration inquiries? Reach out to us at:

• Email: [email protected]