본문 바로가기
WIKI 기술 지식 베이스

알려진 액션(Well-known Actions)

원문 보기 위키 갱신

이 섹션은 Actions Registry에 등록된 다양한 알려진 액션을 나열합니다.

출처: 문서

본문

이 섹션은 Actions Registry에 등록된 다양한 알려진 액션을 나열합니다.

Actions

이는 Actions Registry의 일부로 알려진 액션들의 (포괄적이지 않은) 목록입니다. 항목 형식은 "action-name(Action Title): 축약된 액션 설명"입니다.

Auth

  • auth.who-am-i(Who Am I): 현재 인증된 사용자의 카탈로그 엔티티와 사용자 정보를 반환합니다. 이 액션은 사용자 자격 증명이 필요하며 서비스 또는 인증되지 않은 자격 증명으로는 사용할 수 없습니다.

Catalog

  • catalog.get-catalog-entity(Get Catalog Entity): 소프트웨어 카탈로그에서 단일 엔티티를 가져올 수 있게 해줍니다.

  • catalog.query-catalog-entities(Query Catalog Entities): 술어(predicate) 필터를 사용해 Backstage Software Catalog에서 엔티티를 쿼리합니다.

  • catalog.register-entity(Register entity in the Catalog): 원격 catalog-info.yaml 파일을 가리키는 Location 엔티티를 만들어 Backstage 카탈로그에 하나 이상의 엔티티를 등록합니다.

  • catalog.unregister-entity(Unregister entity from the Catalog): Location 엔티티와 그것이 소유한 모든 엔티티를 Backstage 카탈로그에서 등록 해제합니다.

  • catalog.validate-entity(Validate Catalog Entity): 소프트웨어 카탈로그와 함께 사용하기 위한 catalog-info.yaml 파일 내용을 검증하는 데 사용할 수 있는 액션입니다.

  • catalog.get-catalog-model-description(Get a Catalog Model Description): 등록된 모든 엔티티 kind, 어노테이션, 레이블, 태그, 관계를 포함해 현재 카탈로그 모델의 마크다운 형식 설명을 반환합니다.

Notifications

  • notifications.get-notifications(Get Notifications): 현재 인증된 사용자의 알림을 가져옵니다. 기본적으로 읽지 않은 알림만 반환합니다. 읽기 상태(unread, read, saved, all), 심각도, 주제, 자유 텍스트 검색, 생성 날짜로 필터링을 지원합니다. offset과 limit을 통한 페이지네이션을 지원합니다.

Kubernetes

  • kubernetes.get-kubernetes-clusters(Get Kubernetes Clusters): 이 Backstage 인스턴스에 등록된 모든 Kubernetes 클러스터를 그 이름, 선택적 표시 제목, 선택적 대시보드 URL과 함께 나열합니다.

  • kubernetes.get-kubernetes-resources-for-entity(Get Kubernetes Resources for Entity): 카탈로그 엔티티와 연관된 라이브 Kubernetes 리소스(pod, deployment, service 등)를 등록된 모든 클러스터에 걸쳐 가져옵니다. name, 선택적 kind(기본값 Component), 선택적 namespace(기본값 default)를 받습니다. 엔티티는 backstage.io/kubernetes-id 또는 backstage.io/kubernetes-label-selector 어노테이션이 있어야 합니다.

Scaffolder

  • scaffolder.dry-run-template(Dry Run Scaffolder Template): 변경을 만들지 않고 scaffolder 템플릿을 검증하기 위해 드라이 런합니다. 실행 로그와 함께 성공을 반환하거나, 검증 실패에 대한 오류를 반환합니다.

  • scaffolder.list-scaffolder-actions(List Scaffolder Actions): 설치된 모든 Scaffolder 액션을 나열합니다.

  • scaffolder.list-scaffolder-tasks(List Scaffolder Tasks): 생성된 scaffolder 작업을 나열할 수 있게 해줍니다.

  • scaffolder.execute-template(Execute Scaffolder Template): 템플릿 ref와 입력 매개변수 값으로 Scaffolder 템플릿을 실행합니다.

  • scaffolder.get-scaffolder-task-logs(Get Scaffolder Task Logs): 주어진 scaffolder 작업의 로그를 가져올 수 있게 해줍니다.

  • search.query(Query Search Engine): 모든 또는 선택된 문서 유형에 걸쳐 Backstage 검색 엔진에서 문서를 쿼리합니다.

더 알아보기 (Learn more)