{"id":20847263,"url":"https://github.com/galaxy-future/costpilot","last_synced_at":"2025-05-12T02:31:18.058Z","repository":{"id":61596481,"uuid":"542505110","full_name":"galaxy-future/costpilot","owner":"galaxy-future","description":"CostPilot is an all-in-one cloud cost management platform that applies to applications hosted on all cloud platforms.","archived":false,"fork":false,"pushed_at":"2023-03-14T02:33:10.000Z","size":5320,"stargazers_count":29,"open_issues_count":5,"forks_count":20,"subscribers_count":3,"default_branch":"dev","last_synced_at":"2024-06-20T15:47:53.653Z","etag":null,"topics":["cloudnative","finops"],"latest_commit_sha":null,"homepage":"https://www.galaxy-future.com/productCostPilot","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/galaxy-future.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-28T09:18:01.000Z","updated_at":"2024-06-03T11:53:24.000Z","dependencies_parsed_at":"2024-06-20T15:33:48.981Z","dependency_job_id":"a016123f-26e0-484f-84a1-6627d50ba3d3","html_url":"https://github.com/galaxy-future/costpilot","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galaxy-future%2Fcostpilot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galaxy-future%2Fcostpilot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galaxy-future%2Fcostpilot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galaxy-future%2Fcostpilot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/galaxy-future","download_url":"https://codeload.github.com/galaxy-future/costpilot/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225115816,"owners_count":17423153,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudnative","finops"],"created_at":"2024-11-18T02:19:30.140Z","updated_at":"2024-11-18T02:19:30.802Z","avatar_url":"https://github.com/galaxy-future.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CostPilot\n[![CodeFactor](https://www.codefactor.io/repository/github/galaxy-future/costpilot/badge)](https://www.codefactor.io/repository/github/galaxy-future/costpilot)\n\nLanguage\n----\n\nEnglish | [中文](https://github.com/galaxy-future/costpilot/blob/dev/docs/CH-README.md)\n\nIntroduction\n-----\nCostPilot is an all-in-one cloud cost management platform that applies to applications hosted on all cloud platforms. Developed by Galaxy-Future based on the FinOps discipline, CostPilot helps enterprises cut cloud spending by up to 50%. This platform provides deep insights into your cloud cost, periodic reports that contain both cloud cost data and professional cost optimization suggestions from multiple perspectives, and even state-of-the-art techniques that you can use to efficiently optimize cloud usage.\n\nGetting Started Guide\n----\n#### 1. Configuration Requirements\n\n- To ensure stable operation of the system, we recommend that you use a server with at least 2 CPU cores and 4 GB RAM. For Linux and MacOS systems, CostPilot has already been tested.\n- The AK/SK used in operation needs to have the permission to read the bill (charge) of the corresponding cloud account.\n\n#### 2. Run in Source Code\nTo run CostPilot in source code, you need to install Git ( [Git - Downloads](https://git-scm.com/downloads)) and Go (**version 1.17+ is required**) and set your Go workspace first.\n\n* (1) Download source code\n  \u003e git clone https://github.com/galaxy-future/costpilot.git\n* (2) Use environment variables. You can analyze only one cloud account at a time if you use this method.\n  - Replace 'abc' with your own AK/SK.\n  ```shell\n       COSTPILOT_PROVIDER=AlibabaCloud COSTPILOT_AK=abc COSTPILOT_SK=abc COSTPILOT_REGION_ID=cn-beijing go run .\n  ```\n* (3) Use a configuration file. You can analyze multiple cloud accounts at a time if you use this method.\n    -  Edit conf/config.yaml as follows. You can add multiple items in cloud_accounts. Only AlibabaCloud is supported as provider for now.\n     ```yaml\n        cloud_accounts:\n          - provider:  # required :AlibabaCloud\n            ak:  # required\n            sk:  # required\n            region_id:  # required\n            name:  # not required\n    ```\n    - Execute the following make command:\n        ```shell\n        make build \u0026\u0026 make run\n      ```\n    - After the analysis is complete, visit website/index.html in a browser to view the analysis result.\n\n#### 3. Run in Docker\nTo run CostPilot in Docker, you need to install Docker first. For more information, see\n[Docker Engine Install](https://docs.docker.com/engine/install/).\n\n* (1) Use environment variables. You can analyze only one cloud account at a time if you use this method.\n  - Replace 'abc' with your own AK/SK.\n    ```shell\n    docker run --env COSTPILOT_PROVIDER=AlibabaCloud --env COSTPILOT_AK=abc --env COSTPILOT_SK=abc --env COSTPILOT_REGION_ID=cn-beijing -p 8504:8504 --name=costpilot galaxyfuture/costpilot\n    ```\n* (2) Use a configuration file. You can analyze multiple cloud accounts at a time if you use this method.\n  - Create your own config.yaml file, and then execute the following command. Replace /tmp/config.yaml with the absolute\n    path of your config.yaml file.\n    ```shell\n    docker run --mount type=bind,source=/tmp/config.yaml,target=/home/tiger/app/conf/config.yaml -p 8504:8504 --name=costpilot galaxyfuture/costpilot\n    ```\n\n#### 4. Sample Result\n\n![bill](https://user-images.githubusercontent.com/78481036/201895818-d3866cae-594c-492f-8ee4-d2b5fb4617b9.png)\n![utilization](https://user-images.githubusercontent.com/78481036/201895847-c1a7879e-5008-454f-8e56-220f549237a0.png)\n\n#### 5. Data Flow Diagram\n\n![costpilot-architecture](docs/costpilot-architecture.png)\n\nCode of Conduct\n------\n[Contributor Convention](https://github.com/galaxy-future/costpilot/blob/master/CODE_OF_CONDUCT)\n\nAuthorization\n-----\n\nCostPilot uses [Apache License 2.0](https://github.com/galaxy-future/costpilot/blob/master/LICENSE) licensing agreement\nfor authorization.\n\nContact Us\n-----\n\n[Weibo](https://weibo.com/galaxyfuture) | [Zhihu](https://www.zhihu.com/org/xing-yi-wei-lai) | [Bilibili](https://space.bilibili.com/2057006251)\n| [WeChat Official Account](https://github.com/galaxy-future/comandx/blob/main/docs/resource/wechat_official_account.md)\n\nIf you want more information about the service, scan the following QR code to contact us:\n\n![image](https://user-images.githubusercontent.com/102009012/163559389-813afa06-924f-412d-8642-1a0944384f91.png)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalaxy-future%2Fcostpilot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgalaxy-future%2Fcostpilot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalaxy-future%2Fcostpilot/lists"}