abctl
v0.22.0
로컬 Airbyte 배포를 위한 Airbyte의 명령줄 도구입니다.
메모
이 README는 주로 Airbyte 플랫폼이 아닌 abctl 도구 자체에 중점을 둡니다.
Airbyte의 공식 빠른 시작 문서를 찾고 있다면 여기에서 찾을 수 있습니다.
빠른 시작
개요
명령
기여
중요한
인증 자격 증명은 설치 프로세스의 일부로 무작위로 생성됩니다.
설치가 완료된 후 인증 자격 증명을 찾으려면 abctl local credentials 실행하세요.
Docker 설치
리눅스
스코틀랜드 사람
윈도우
abctl 설치
양조를 통해
brew tap airbytehq/tap brew install abctl
이동 설치를 통해
go install github.com/airbytehq/abctl@latest
Github를 통해
Airbyte 설치
# install Airbyte abctl local install # fetch the login credentials abctl local credentials
메모
인터넷 속도에 따라 abctl local install 15분 이상 걸릴 수 있습니다.
기본적으로 abctl local install 포트 8000 의 모든 인바운드 요청이 액세스할 수 있도록 Airbyte를 구성합니다. 여기에는 일반적으로 호스트의 IP 주소 및 localhost 통한 액세스가 포함됩니다.
포트 8000 사용할 수 없는 경우. 또는 다른 포트가 선호되는 경우 --port [PORT] 지정할 수 있습니다.
Airbyte 에 로그인하세요
abctl local install 성공적으로 완료되면 http://localhost:8000(또는 지정된 경우 --host 및 --port 재정의)에 대한 브라우저가 열려야 합니다. Airbyte를 처음 설치하는 경우 이메일과 조직 이름을 제공하라는 메시지가 표시됩니다. 로그인 비밀번호를 검색하려면 abctl local credentials 실행하세요.
빠른 시작에서 언급했듯이 abctl 의 유일한 전제 조건은 Docker를 설치하고, 실행하고, 액세스할 수 있어야 한다는 것입니다. 그러나 Airbyte 플랫폼에는 abctl kind(kind는 Docker 컨테이너 내에서 Kubernetes 클러스터를 실행함)를 활용하여 생성하는 Kubernetes 클러스터가 필요합니다. 종류의 Kubernetes 클러스터에서 abctl helm을 사용하여 최신(기본적으로) Airbyte helm 차트 및 최신 NGINX Ingress Controller helm 차트를 설치(또는 업데이트)합니다.
모든 명령과 하위 명령은 다음과 같은 선택적 전역 플래그를 지원합니다.
| 짧은 | 긴 | 설명 |
|---|---|---|
| -시간 | --돕다 | 도움말 정보, 사용 가능한 옵션에 대한 설명을 표시합니다. |
| -다섯 | --말 수가 많은 | 자세한(디버그) 출력을 활성화합니다. 예상치 못한 동작을 디버깅할 때 유용합니다. |
모든 명령은 다음 환경 변수를 지원합니다.
| 이름 | 설명 |
|---|---|
| DO_NOT_TRACK | 원격 측정 추적을 비활성화하려면 임의의 값으로 설정하십시오. |
다음 명령이 지원됩니다.
현지의
버전
abctl local --help
로컬 하위 명령은 로컬 Airbyte 설치 관리에 중점을 둡니다. 다음 하위 명령을 사용할 수 있습니다.
신임장
배포
설치하다
상태
제거
abctl local credentials
로컬 Airbyte 설치에 로그인하는 데 필요한 자격 증명을 표시합니다.
메모
abctl local install 처음 실행하면 임의의 password , client-id , client-secret 생성됩니다.
email , password , client-id 및 client-secret 자격 증명을 반환합니다. Airbyte에 로그인하려면 email 과 password 필요합니다. Airbyte API와 상호작용하기 위한 Access Token 생성하려면 client-id 와 client-secret 필요합니다.
예를 들어:
$ abctl local credentials
{
"password": "[RANDOM PASSWORD]",
"client-id": "[RANDOM CLIENT-ID]",
"client-secret": "[RANDOM CLIENT-SECRET]"
} credentials 다음 선택적 플래그를 지원합니다.
| 이름 | 기본 | 설명 |
|---|---|---|
| --이메일 | "" | 인증 이메일 주소를 변경합니다. |
| --비밀번호 | "" | 인증 비밀번호를 변경합니다. |
abctl local deployments
kubernetes 배포 정보를 표시하고 kubernetes 배포를 다시 시작할 수 있도록 합니다.
deployments 다음과 같은 선택적 플래그를 지원합니다.
| 이름 | 기본 | 설명 |
|---|---|---|
| --재시작 | "" | 제공된 배포를 다시 시작합니다. |
abctl local install
로컬 Airbyte 인스턴스를 설치하거나 abctl 에 의해 처음 설치된 기존 설치를 업데이트합니다.
메모
인터넷 속도에 따라 abctl local install 에 20분 이상 걸릴 수 있습니다.
install 다음과 같은 선택적 플래그를 지원합니다.
메모
기본 열의 - 는 값을 제공할 수 없음을 나타냅니다.
이러한 플래그는 스위치 역할을 하며, 제공되면 활성화되고 그렇지 않으면 비활성화됩니다.
| 이름 | 기본 | 설명 |
|---|---|---|
| --차트 | "" | 차트 경로입니다. |
| --차트 버전 | 최신 | 설치할 Airbyte helm-chart 버전. |
| --docker-이메일 | "" | --docker-server 에 대해 인증할 Docker 이메일 주소입니다.환경 변수 ABCTL_LOCAL_INSTALL_DOCKER_EMAIL 로 지정할 수도 있습니다. |
| --docker-비밀번호 | "" | --docker-server 에 대해 인증하기 위한 Docker 비밀번호입니다.환경 변수 ABCTL_LOCAL_INSTALL_DOCKER_PASSWORD 로 지정할 수도 있습니다. |
| --docker-서버 | "" | 인증할 Docker 서버입니다. 환경 변수 ABCTL_LOCAL_INSTALL_DOCKER_SERVER 로 지정할 수도 있습니다. |
| --docker-사용자 이름 | "" | --docker-server 에 대해 인증하기 위한 Docker 사용자 이름입니다.환경 변수 ABCTL_LOCAL_INSTALL_DOCKER_USERNAME 으로 지정할 수도 있습니다. |
| --안전하지 않은 쿠키 | - | 보안 쿠키 요구 사항을 비활성화합니다. 안전하지 않은( https 가 아닌) 연결에서 --host 사용하는 경우에만 설정됩니다. |
| --낮은 리소스 모드 | 거짓 | 리소스 부족 모드에서 Airbyte를 실행하세요. |
| --주인 | "" | Airbyte 설치에 액세스할 FQDN입니다. 기본값은 포트 --port 에서 들어오는 모든 트래픽을 허용하는 것입니다.Airbyte 설치에 더 제한된 호스트 구성이 필요한 경우 이를 설정하십시오. |
| --마이그레이션 | - | 기존 docker-compose 지원 Airbyte 설치에서 데이터 마이그레이션을 활성화합니다. 원본 데이터를 수정하지 않은 채로 docker-compose의 데이터를 복사합니다. 이 abctl 관리 Airbyte 설치에 Airbyte 설치를 백업했습니다. |
| --브라우저 없음 | - | 설치가 완료되면 브라우저 실행을 비활성화합니다. 브라우저를 사용할 수 없는 상황에서 설정하면 유용합니다. |
| --포트 | 8000 | Airbyte 설치에 액세스할 포트입니다. 포트 8000이 이미 사용 중이거나 다른 포트를 선호하는 경우 이를 설정하십시오. |
| --비밀 | "" | 여러 번 설정할 수 있습니다 . 제공된 파일의 콘텐츠를 기반으로 Kubernetes 보안 비밀을 생성합니다. 설치 사용자 정의를 위해 --values 와 함께 사용하면 유용합니다. |
| --값 | "" | Airbyte 설치를 추가로 사용자 정의하기 위한 Helm 값 파일입니다. |
| --용량 | "" | 여러 번 설정할 수 있습니다 . Kubernetes 클러스터에 추가 볼륨을 마운트합니다. <HOST_PATH>:<GUEST_PATH> 형식이어야 합니다. |
abctl local status
Airbyte 설치가 존재하는 경우 해당 설치에 관한 정보를 반환합니다.
예를 들어:
$ abctl local status Existing cluster 'airbyte-abctl' found Found helm chart 'airbyte-abctl' Status: deployed Chart Version: 0.422.2 App Version: 0.63.15 Found helm chart 'ingress-nginx' Status: deployed Chart Version: 4.11.1 App Version: 1.11.1 Airbyte should be accessible via http://localhost:8000
abctl local uninstall
로컬 Airbyte 인스턴스를 제거합니다.
메모
설치된 Airbyte 인스턴스와 관련된 데이터는 제거되지 않습니다.
이는 나중에 모든 데이터가 보존된 상태로 Airbyte를 다시 설치할 수 있도록 하기 위한 것입니다.
uninstall 다음과 같은 선택적 플래그를 지원합니다.
메모
기본 열의 - 는 값을 제공할 수 없음을 나타냅니다.
이러한 플래그는 스위치 역할을 하며, 제공되면 활성화되고 그렇지 않으면 비활성화됩니다.
| 이름 | 기본 | 설명 |
|---|---|---|
| --지속됨 | - | Airbyte 설치를 위한 모든 데이터가 제거됩니다. 이 작업은 취소할 수 없습니다. |
abctl images
Airbyte 및 abctl에서 사용되는 이미지를 관리합니다.
다음 하위 명령을 사용할 수 있습니다.
명백한
abctl images manifest
Airbyte 및 abctl에서 사용하는 이미지의 매니페스트를 표시합니다.
| 이름 | 기본 | 설명 |
|---|---|---|
| --차트 | "" | 차트 경로입니다. |
| --차트 버전 | 최신 | 설치할 Airbyte helm-chart 버전. |
| --값 | "" | Airbyte 설치를 추가로 사용자 정의하기 위한 Helm 값 파일입니다. |
abctl version
abctl 도구에 대한 버전 정보를 표시합니다.
예를 들어:
$ abctl version version: v0.19.0
abctl 에서 문제를 발견한 경우 Github 이슈를 열고 ? [abctl] Report an issue with the abctl tool .
설치 go
양조를 통해
brew install go
go.dev를 통해
이 저장소는 Makefile을 활용하여 go 코드의 형식 지정, 조사, 빌드 및 테스트에 사용되는 기존 go 명령을 래핑합니다.
다음 make 명령이 지원됩니다.
| 이름 | 설명 |
|---|---|
make build | abctl 바이너리를 빌드하여 build 디렉터리에 배치합니다. |
make clean | build 디렉터리를 제거합니다. |
make fmt | 코드 형식을 지정합니다. |
make test | 모든 테스트를 실행합니다. |
make vet | vet 명령을 실행합니다. |
