alsalty/argocd-sdk

Argo CD 的 PHP 库

维护者

详细信息

github.com/mohamadalsalty/argocd-sdk

源代码

问题

安装: 2

依赖: 0

建议: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

1.0.0 2024-08-03 15:51 UTC

Requires

  • php: >=8
  • ext-curl: *

MIT de988d3ed6069b246d12e4d83913040384addc33

  • MOHAMAD AL SALTY <mohamadhazems.woop@gmail.com>

devopsArgoCD

This package is auto-updated.

Last update: 2024-09-03 16:03:59 UTC

README

此 PHP SDK 库提供了一种简单的方式来与 Argo CD 的 API 进行交互，允许您管理应用程序、集群等。

功能

  • 使用用户名和密码通过 Argo CD API 进行认证
  • 使用项目和命名空间过滤器管理应用程序
  • 检索应用程序的信息和名称

安装

使用 Composer

您可以通过 Composer 安装此库。在您的终端中运行以下命令

composer require alsalty/argocd-sdk

使用方法

基本示例

require 'vendor/autoload.php';

use Alsalty\Argocd\Core\Auth;
use Alsalty\Argocd\Core\Managers\ApplicationsManager;

try {
    // Set your Argo CD API credentials
    $apiUrl = 'https://your-argocd-api-url';
    $username = 'your-username';
    $password = 'your-password';

    // Create an Auth instance and authenticate
    $auth = new Auth($apiUrl, $username, $password);
    $auth->authenticate();

    // Create an ApplicationsManager instance
    $appManager = new ApplicationsManager($auth);

    // Set projects and namespace filters
    $appManager->setProjects(['project1', 'project2']);
    $appManager->setAppNamespace('namespace1');

    // Fetch and print application names
    $applicationNames = $appManager->getApplicationsNames();
    print_r($applicationNames);

} catch (Exception $e) {
    echo 'Error: ' . $e->getMessage();
}

过滤应用程序

您可以通过项目和命名空间来过滤应用程序

  • 项目：设置多个项目以通过这些项目过滤应用程序。
  • 命名空间：设置一个命名空间以通过特定命名空间过滤应用程序。
$appManager->setProjects(['project1', 'project2']);
$appManager->setAppNamespace('namespace1');

配置

您可以配置以下参数

  • API URL：您的 Argo CD API 服务器的 URL。
  • 用户名：您的 Argo CD 用户名。
  • 密码：您的 Argo CD 密码。

开发

结构

  • src/Core：包含核心类，如 Auth 和管理者。
  • src/Helpers：包含辅助类，如 Curl。
  • tests：包含测试用例。

贡献

欢迎贡献！

许可

本项目采用 MIT 许可证。有关详细信息，请参阅 LICENSE 文件。