Red Hat Summit Red Hat Summit지원콘솔개발자평가판 시작연락처

7.5.2. OpenShift Container Platform 콘솔 API

useActivePerspective

현재 활성화된 관점과 활성 관점을 설정하기 위한 콜백을 제공하는 후크. 현재 활성화된 관점 및 setter 콜백을 포함하는 DestinationRule을 반환합니다. 

const Component: React.FC = (props) => {
   const [activePerspective, setActivePerspective] = useActivePerspective();
   return <select
     value={activePerspective}
     onChange={(e) => setActivePerspective(e.target.value)}
   >
     {
       // ...perspective options
     }
   </select>
}
GreenCheckCircleIcon

녹색 확인 표시 원 아이콘을 표시하는 구성 요소입니다. 

<GreenCheckCircleIcon title="Healthy" />
Expand
매개변수 이름설명

className

(선택 사항) 구성 요소의 추가 클래스 이름입니다.

title

(선택 사항) 아이콘 제목

크기

(선택 사항) 아이콘 크기: ('sm', 'md', 'lg', 'xl')

RedExclamationCircleIcon

빨간색 느낌표 원 아이콘을 표시하는 구성 요소입니다. 

<RedExclamationCircleIcon title="Failed" />
Expand
매개변수 이름설명

className

(선택 사항) 구성 요소의 추가 클래스 이름입니다.

title

(선택 사항) 아이콘 제목

크기

(선택 사항) 아이콘 크기: ('sm', 'md', 'lg', 'xl')

YellowExclamationTriangleIcon

노란색 구분 기호 아이콘을 표시하는 구성 요소입니다. 

<YellowExclamationTriangleIcon title="Warning" />
Expand
매개변수 이름설명

className

(선택 사항) 구성 요소의 추가 클래스 이름입니다.

title

(선택 사항) 아이콘 제목

크기

(선택 사항) 아이콘 크기: ('sm', 'md', 'lg', 'xl')

BlueInfoCircleIcon

Blue info 원 아이콘을 표시하는 구성 요소입니다. 

<BlueInfoCircleIcon title="Info" />
Expand
매개변수 이름설명

className

(선택 사항) 구성 요소의 추가 클래스 이름입니다.

title

(선택 사항) 아이콘 제목

크기

(선택 사항) 아이콘 크기: ('sm', 'md', 'lg', 'xl')

ErrorStatus

오류 상태 팝업을 표시하는 구성 요소입니다. 

<ErrorStatus title={errorMsg} />
Expand
매개변수 이름설명

title

(선택 사항) 상태 텍스트

iconOnly

(선택 사항) true인 경우 아이콘만 표시합니다.

noTooltip

(선택 사항) true인 경우 툴팁이 표시되지 않습니다.

className

(선택 사항) 구성 요소의 추가 클래스 이름입니다.

popoverTitle

(선택 사항) 팝업의 제목

InfoStatus

정보 상태 팝업을 표시하는 구성 요소입니다. 

<InfoStatus title={infoMsg} />
Expand
매개변수 이름설명

title

(선택 사항) 상태 텍스트

iconOnly

(선택 사항) true인 경우 아이콘만 표시합니다.

noTooltip

(선택 사항) true인 경우 툴팁이 표시되지 않습니다.

className

(선택 사항) 구성 요소의 추가 클래스 이름입니다.

popoverTitle

(선택 사항) 팝업의 제목

ProgressStatus

진행 상태 팝업을 표시하는 구성 요소입니다. 

<ProgressStatus title={progressMsg} />
Expand
매개변수 이름설명

title

(선택 사항) 상태 텍스트

iconOnly

(선택 사항) true인 경우 아이콘만 표시합니다.

noTooltip

(선택 사항) true인 경우 툴팁이 표시되지 않습니다.

className

(선택 사항) 구성 요소의 추가 클래스 이름입니다.

popoverTitle

(선택 사항) 팝업의 제목

successStatus

성공 상태 팝업을 표시하는 구성 요소입니다. 

<SuccessStatus title={successMsg} />
Expand
매개변수 이름설명

title

(선택 사항) 상태 텍스트

iconOnly

(선택 사항) true인 경우 아이콘만 표시합니다.

noTooltip

(선택 사항) true인 경우 툴팁이 표시되지 않습니다.

className

(선택 사항) 구성 요소의 추가 클래스 이름입니다.

popoverTitle

(선택 사항) 팝업의 제목

checkAccess

지정된 리소스에 대한 사용자 액세스에 대한 정보를 제공합니다. 리소스 액세스 정보를 사용하여 오브젝트를 반환합니다.

Expand
매개변수 이름설명

resourceAttributes

액세스 검토를 위한 리소스 속성

impersonate

가장 세부 정보

useAccessReview

지정된 리소스에 대한 사용자 액세스에 대한 정보를 제공하는 후크. isAllowed 및 loading 값을 사용하여 배열을 반환합니다.

Expand
매개변수 이름설명

resourceAttributes

액세스 검토를 위한 리소스 속성

impersonate

가장 세부 정보

useResolvedExtensions

확인된 CodeRef 속성과 함께 콘솔 확장을 사용하기 위한 react hook입니다. 이 후크는 useExtensions 후크로 동일한 인수를 수락하고 조정된 확장 인스턴스 목록을 반환하여 각 확장 기능 속성 내의 모든 코드 참조를 해결합니다. 처음에 후크는 빈 배열을 반환합니다. 해결이 완료되면 React 구성 요소가 조정된 확장 목록을 반환하는 후크로 다시 렌더링됩니다. 일치하는 확장 목록이 변경되면 확인이 다시 시작됩니다. 해결이 완료될 때까지 후크는 이전 결과를 계속 반환합니다. 후크의 결과 요소는 re-render에서 참조로 안정적으로 유지됩니다. 해결된 코드 참조가 있는 조정된 확장 인스턴스 목록, 확인 중 확인이 완료되었는지 여부를 나타내는 부울 플래그, 해결 중 감지된 오류 목록을 포함하는 DestinationRule을 반환합니다. 

const [navItemExtensions, navItemsResolved] = useResolvedExtensions<NavItem>(isNavItem);
// process adapted extensions and render your component
Expand
매개변수 이름설명

typeGuards

각각 동적 플러그인 확장을 인수로 수락하고 확장이 원하는 유형 제약 조건을 충족하는지 여부를 나타내는 부울 플래그를 반환하는 콜백 목록

HorizontalNav

페이지의 탐색 모음을 만드는 구성 요소는 구성 요소의 일부로 처리됩니다.- Routing은 구성 요소의 일부로 처리됩니다.- console.tab/horizontalNav 는 모든 수평 nav에 콘텐츠를 추가하는 데 사용할 수 있습니다. 

const HomePage: React.FC = (props) => {
    const page = {
      href: '/home',
      name: 'Home',
      component: () => <>Home</>
    }
    return <HorizontalNav match={props.match} pages={[page]} />
}
Expand
매개변수 이름설명

resource

이 Navigation과 관련된 리소스, K8sResourceCommon 유형의 개체

페이지

페이지 오브젝트의 배열

match

React Router에서 제공하는 일치 오브젝트

VirtualizedTable

가상화된 테이블을 만드는 구성 요소입니다. 

const MachineList: React.FC<MachineListProps> = (props) => {
  return (
    <VirtualizedTable<MachineKind>
     {...props}
     aria-label='Machines'
     columns={getMachineColumns}
     Row={getMachineTableRow}
    />
  );
}
Expand
매개변수 이름설명

data

표의 데이터

Loaded

데이터가 로드되었음을 나타내는 플래그

loadError

데이터 로드에 문제가 있는 경우 오류 개체

열

열 설정

row

행 설정

unfilteredData

필터가 없는 원본 데이터

NoDataEmptyMsg

(선택 사항) 데이터 빈 메시지 구성 요소가 없음

EmptyMsg

(선택 사항) 빈 메시지 구성 요소

scrollNode

(선택 사항) 스크롤을 처리하는 기능

label

(선택 사항) 표의 라벨

ariaLabel

(선택 사항) label

gridBreakPoint

응답성을 위해 Grid의 크기 조정

onSelect

(선택 사항) 표 선택 처리를 위한 기능

rowData

(선택 사항) 행과 관련된 데이터

TableData

테이블 행 내에 테이블 데이터를 표시하는 구성 요소입니다. 

const PodRow: React.FC<RowProps<K8sResourceCommon>> = ({ obj, activeColumnIDs }) => {
  return (
    <>
      <TableData id={columns[0].id} activeColumnIDs={activeColumnIDs}>
        <ResourceLink kind="Pod" name={obj.metadata.name} namespace={obj.metadata.namespace} />
      </TableData>
      <TableData id={columns[1].id} activeColumnIDs={activeColumnIDs}>
        <ResourceLink kind="Namespace" name={obj.metadata.namespace} />
      </TableData>
    </>
  );
};
Expand
매개변수 이름설명

id

테이블의 고유 ID

activeColumnIDs

활성 열

className

(선택 사항) 옵션 클래스 이름

useActiveColumns

사용자가 선택한 활성 테이블 DestinationRules 목록을 제공하는 후크입니다. 

  // See implementation for more details on TableColumn type
  const [activeColumns, userSettingsLoaded] = useActiveColumns({
    columns,
    showNamespaceOverride: false,
    columnManagementID,
  });
  return userSettingsAreLoaded ? <VirtualizedTable columns= {activeColumns} {...otherProps} /> : null
Expand
매개변수 이름설명

options

키-값 맵으로 전달되는 방법

``

\{TableECDHE[]} options.columns - 사용 가능한 모든 TableECDHEs의 배열

``

{Boolean} [options.showNamespaceOverride] - (선택 사항) true인 경우 열 관리 선택에 관계없이 네임스페이스 열이 포함됩니다.

``

{string} [options.columnManagementID] - (선택 사항) 사용자 설정으로 열 관리 선택을 유지하고 검색하는 데 사용되는 고유 ID입니다. 일반적으로 리소스에 대한 'groupverionkind' 문자열입니다.

현재 사용자가 선택한 활성 열( options.columns의 하위 집합)과 사용자 설정이 로드되었는지 여부를 나타내는 부울 플래그가 포함됩니다.

ListPageHeader

페이지 헤더를 생성하는 구성 요소입니다. 

const exampleList: React.FC = () => {
  return (
    <>
      <ListPageHeader title="Example List Page"/>
    </>
  );
};
Expand
매개변수 이름설명

title

제목

helpECDHE

(선택 사항) help section as react node

badge

(선택 사항) 반응 노드로 배지 아이콘

ListPageCreate

이 리소스의 YAML 생성에 대한 링크를 자동으로 생성하는 특정 리소스 종류에 대한 생성 버튼을 추가하는 구성 요소입니다. 

const exampleList: React.FC<MyProps> = () => {
  return (
    <>
      <ListPageHeader title="Example Pod List Page"/>
        <ListPageCreate groupVersionKind="Pod">Create Pod</ListPageCreate>
      </ListPageHeader>
    </>
  );
};
Expand
매개변수 이름설명

groupVersionKind

나타낼 리소스 그룹/버전/종류

ListPageCreateLink

제대로 된 링크를 만들기 위한 구성 요소입니다. 

const exampleList: React.FC<MyProps> = () => {
 return (
  <>
   <ListPageHeader title="Example Pod List Page"/>
      <ListPageCreateLink to={'/link/to/my/page'}>Create Item</ListPageCreateLink>
   </ListPageHeader>
  </>
 );
};
Expand
매개변수 이름설명

다음으로 변경

링크가 직접해야 하는 문자열 위치

createAccessReview

(선택 사항) 네임스페이스가 있는 오브젝트와 액세스를 결정하는 데 사용되는 종류

children

(선택 사항) 구성 요소에 대한 하위 항목

ListPageCreateButton

버튼을 생성하는 구성 요소입니다. 

const exampleList: React.FC<MyProps> = () => {
  return (
    <>
      <ListPageHeader title="Example Pod List Page"/>
        <ListPageCreateButton createAccessReview={access}>Create Pod</ListPageCreateButton>
      </ListPageHeader>
    </>
  );
};
Expand
매개변수 이름설명

createAccessReview

(선택 사항) 네임스페이스가 있는 오브젝트와 액세스를 결정하는 데 사용되는 종류

pfButtonProps

(선택 사항) Patternfly Button props

ListPageCreateDropdown

권한 확인으로 줄 바꿈 드롭다운을 생성하는 구성 요소입니다. 

const exampleList: React.FC<MyProps> = () => {
  const items = {
    SAVE: 'Save',
    DELETE: 'Delete',
  }
  return (
    <>
     <ListPageHeader title="Example Pod List Page"/>
       <ListPageCreateDropdown createAccessReview={access} items={items}>Actions</ListPageCreateDropdown>
     </ListPageHeader>
    </>
  );
};
Expand
매개변수 이름설명

항목

key:ReactNode 쌍의 드롭다운 구성 요소에 표시할 항목

onClick

드롭다운 항목을 클릭하기 위한 콜백 함수

createAccessReview

(선택 사항) 네임스페이스가 있는 오브젝트와 액세스를 결정하는 데 사용되는 종류

children

(선택 사항) 드롭다운 토글의 하위 항목

ListPageFilter

목록 페이지에 대한 필터를 생성하는 구성 요소입니다. 

  // See implementation for more details on RowFilter and FilterValue types
  const [staticData, filteredData, onFilterChange] = useListPageFilter(
    data,
    rowFilters,
    staticFilters,
  );
  // ListPageFilter updates filter state based on user interaction and resulting filtered data can be rendered in an independent component.
  return (
    <>
      <ListPageHeader .../>
      <ListPagBody>
        <ListPageFilter data={staticData} onFilterChange={onFilterChange} />
        <List data={filteredData} />
      </ListPageBody>
    </>
  )
Expand
매개변수 이름설명

data

데이터 지점의 배열

Loaded

데이터가 로드되었음을 나타냅니다.

onFilterChange

filter가 업데이트될 때의 콜백 함수

rowFilters

(선택 사항) 사용 가능한 필터 옵션을 정의하는 RowFilter 요소의 배열입니다.

nameFilterPlaceholder

(선택 사항) 이름 필터의 자리 표시자

labelFilterPlaceholder

(선택 사항) 라벨 필터의 자리 표시자

hideLabelFilter

(선택 사항) 이름 필터와 레이블 필터 대신 이름 필터만 표시합니다.

hideNameLabelFilter

(선택 사항) 이름 필터와 레이블 필터를 모두 숨깁니다.

columnLayout

(선택 사항) 열 레이아웃 오브젝트

hideColumnManagement

(선택 사항) 열 관리를 숨기는 플래그

useListPageFilter

ListPageFilter 구성 요소의 필터 상태를 관리하는 후크입니다. 모든 정적 필터에 의해 필터링된 데이터, 모든 정적 및 행 필터로 필터링된 데이터, rowFilter를 업데이트하는 콜백을 포함하는 DestinationRule을 반환합니다. 

  // See implementation for more details on RowFilter and FilterValue types
  const [staticData, filteredData, onFilterChange] = useListPageFilter(
    data,
    rowFilters,
    staticFilters,
  );
  // ListPageFilter updates filter state based on user interaction and resulting filtered data can be rendered in an independent component.
  return (
    <>
      <ListPageHeader .../>
      <ListPagBody>
        <ListPageFilter data={staticData} onFilterChange={onFilterChange} />
        <List data={filteredData} />
      </ListPageBody>
    </>
  )
Expand
매개변수 이름설명

data

데이터 지점의 배열

rowFilters

(선택 사항) 사용 가능한 필터 옵션을 정의하는 RowFilter 요소의 배열입니다.

staticFilters

(선택 사항) 데이터에 정적으로 적용되는 FilterValue 요소의 배열입니다.

ResourceLink

아이콘 배지와 함께 특정 리소스 유형에 대한 링크를 생성하는 구성 요소입니다. 

  <ResourceLink
      kind="Pod"
      name="testPod"
      title={metadata.uid}
  />
Expand
매개변수 이름설명

kind

(선택 사항) 리소스의 종류 즉 포드, 배포, 네임스페이스

groupVersionKind

(선택 사항) groupd, version 및 kind가 있는 오브젝트

className

(선택 사항) 구성 요소에 대한 클래스 스타일

displayName

(선택 사항) 구성 요소의 표시 이름을 표시하고, 설정된 경우 리소스 이름을 덮어씁니다.

인라인

(선택 사항) 아이콘 배지 및 하위 이름과 함께 이름을 만드는 플래그

linkTo

(선택 사항) Link 오브젝트를 생성하는 플래그 - 기본값은 true입니다.

name

(선택 사항) 리소스 이름

namesapce

(선택 사항) 종류 리소스에 대한 특정 네임스페이스로 연결할 수 있습니다.

hideIcon

(선택 사항) 아이콘 배지를 숨기는 플래그

title

(선택 사항) link 오브젝트의 제목(표시되지 않음)

dataTest

(선택 사항) 테스트의 식별자

onClick

(선택 사항) 구성 요소를 클릭할 때의 콜백 함수

truncate

(선택 사항) 너무 긴 경우 링크를 중지하는 플래그

resourceIcon

특정 리소스 유형에 대한 아이콘 배지를 생성하는 구성 요소입니다. 

<ResourceIcon kind="Pod"/>
Expand
매개변수 이름설명

kind

(선택 사항) 리소스의 종류 즉 포드, 배포, 네임스페이스

groupVersionKind

(선택 사항) group, version 및 kind가 있는 오브젝트

className

(선택 사항) 구성 요소에 대한 클래스 스타일

useK8sModel

redux에서 제공된 K8sGroupVersionKind에 대한 k8s 모델을 검색하는 후크. 첫 번째 항목이 k8s 모델이고 두 번째 항목이 inFlight 상태로 있는 배열을 반환합니다. 

const Component: React.FC = () => {
  const [model, inFlight] = useK8sModel({ group: 'app'; version: 'v1'; kind: 'Deployment' });
  return ...
}
Expand
매개변수 이름설명

groupVersionKind

그룹, 버전, 종류의 k8s 리소스 \{@link K8sGroupVersionKind}는 그룹, 버전, 더 이상 그룹 버전 종류 \{@link K8sResourceKindReference}에 대한 참조를 전달할 수 있습니다.

useK8sModels

redux에서 현재 모든 k8s 모델을 검색하는 후크. 첫 번째 항목이 k8s 모델 목록과 두 번째 항목이 inFlight 상태로 있는 배열을 반환합니다. 

const Component: React.FC = () => {
  const [models, inFlight] = UseK8sModels();
  return ...
}
useK8sWatchResource

로드 및 오류 상태와 함께 k8s 리소스를 검색하는 후크 첫 번째 항목이 있는 배열을 resource(s), 두 번째 항목을 로드된 상태로, 세 번째 항목을 오류 상태로 반환합니다. 

const Component: React.FC = () => {
  const watchRes = {
        ...
      }
  const [data, loaded, error] = useK8sWatchResource(watchRes)
  return ...
}
Expand
매개변수 이름설명

initResource

리소스를 조사하는 데 필요한 옵션.

useK8sWatchResources

로드 및 오류의 각 상태와 함께 k8s 리소스를 검색하는 후크 initResouces에 제공된 키가 있는 맵을 반환하고 value에는 세 가지 속성 데이터, 로드 및 오류가 있습니다. 

const Component: React.FC = () => {
  const watchResources = {
        'deployment': {...},
        'pod': {...}
        ...
      }
  const {deployment, pod} = useK8sWatchResources(watchResources)
  return ...
}
Expand
매개변수 이름설명

initResources

리소스는 키-값 쌍으로 모니터링해야 합니다. 여기서 키는 리소스에 고유하며, 각 리소스를 조사하는 데 필요한 옵션이 됩니다.

consoleFetch

콘솔 특정 헤더를 추가하고 재시도 및 타임아웃을 허용하는 fetch 에 대한 사용자 정의 래퍼를 사용하여 응답 상태 코드의 유효성을 검사하고 필요한 경우 적절한 오류를 발생시키거나 사용자를 로그아웃합니다. 응답에 해결되는 작업을 반환합니다.

Expand
매개변수 이름설명

url

가져올 URL

options

가져오기를 위해 전달할 옵션

timeout

시간 초과(밀리초)

consoleFetchJSON

콘솔 특정 헤더를 추가하고 재시도 및 타임아웃을 허용하는 fetch 관련 사용자 정의 래퍼입니다. 또한 응답 상태 코드의 유효성을 검사하고 적절한 오류가 발생하거나 필요한 경우 사용자를 기록합니다. 응답을 JSON 오브젝트로 반환합니다. 내부적으로 consoleFetch 를 사용합니다. 응답에서 JSON 오브젝트로 확인되는 작업을 반환합니다.

Expand
매개변수 이름설명

url

가져올 URL

method

사용할 HTTP 메서드입니다. 기본값은 GET입니다.

options

가져오기를 위해 전달할 옵션

timeout

시간 초과(밀리초)

cluster

요청할 클러스터의 이름입니다. 기본값은 사용자가 선택한 활성 클러스터입니다.

consoleFetchText

콘솔 특정 헤더를 추가하고 재시도 및 타임아웃을 허용하는 fetch 관련 사용자 정의 래퍼입니다. 또한 응답 상태 코드의 유효성을 검사하고 적절한 오류가 발생하거나 필요한 경우 사용자를 기록합니다. 응답을 텍스트로 반환합니다. 내부적으로 consoleFetch 를 사용합니다. 응답에 텍스트로 해결되는 작업을 반환합니다.

Expand
매개변수 이름설명

url

가져올 URL

options

가져오기를 위해 전달할 옵션

timeout

시간 초과(밀리초)

cluster

요청할 클러스터의 이름입니다. 기본값은 사용자가 선택한 활성 클러스터입니다.

getConsoleRequestHeaders

현재 redux 상태를 사용하여 API 요청에 대한 가장 및 다중 클러스터 관련 헤더를 생성하는 함수입니다. redux 상태에 따라 적절한 가장 및 clustr requst 헤더가 포함된 오브젝트를 반환합니다.

Expand
매개변수 이름설명

targetCluster

제공된 targetCluster로 현재 활성 클러스터 덮어쓰기

k8sGetResource

제공된 옵션에 따라 클러스터에서 리소스를 가져옵니다. 이름이 제공되면 하나의 리소스를 반환하고 다른 리소스는 모델과 일치하는 모든 리소스를 반환합니다. 이 명령은 이름이 모델에 일치하는 모든 리소스를 반환하는 경우 리소스가 포함된 JSON 오브젝트로 응답을 확인하는 것을 반환합니다. 실패하는 경우 HTTP 오류 응답을 사용하여 스키마가 거부됩니다.

Expand
매개변수 이름설명

options

맵에서 키-값 쌍으로 전달되는 경우

``

options.model - k8s 모델

``

options.name - 리소스 이름이 제공되지 않으면 해당 모델과 일치하는 모든 리소스를 찾습니다.

``

options.ns - 확인할 네임스페이스로 클러스터 범위의 리소스에 대해 지정하지 않아야 합니다.

``

options.path - 지정된 경우 하위 경로로 적용

``

options.queryParams - URL에 포함할 쿼리 매개변수입니다.

``

options.requestInit - 사용할 fetch init 오브젝트입니다. 여기에는 요청 헤더, 메서드, 리디렉션 등이 있을 수 있습니다. 자세한 내용은 (link: https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules_typedoc_node_modules_typescript_lib_dom_d.requestinit.html)을 참조하십시오.

k8sCreateResource

제공된 옵션에 따라 클러스터에 리소스를 생성합니다. 생성된 리소스의 응답으로 확인되는 커밋을 반환합니다. 실패의 경우 HTTP 오류 응답을 사용하여 거부됩니다.

Expand
매개변수 이름설명

options

맵에서 키-값 쌍으로 전달되는 경우

``

options.model - k8s 모델

``

options.data - 생성할 리소스의 페이로드

``

options.path - 지정된 경우 하위 경로로 적용

``

options.queryParams - URL에 포함할 쿼리 매개변수입니다.

k8sUpdateResource

providedoptions를 기반으로 클러스터의 전체 리소스를 업데이트합니다. 클라이언트가 기존 리소스를 완전히 교체해야 하는 경우 k8sUpdate를 사용할 수 있습니다. 또는 k8sPatch를 사용하여 부분 업데이트를 수행할 수 있습니다. 업데이트된 리소스의 응답으로 확인되는 커밋을 반환합니다. 실패의 경우 HTTP 오류 응답을 사용하여 거부됩니다.

Expand
매개변수 이름설명

options

맵에서 키-값 쌍으로 전달되는 방법

``

options.model - k8s 모델

``

options.data - k8s 리소스의 페이로드 업데이트

``

options.ns - 조회할 네임스페이스로, 클러스터 범위의 리소스에 대해 지정하지 않아야 합니다.

``

options.name - 업데이트할 리소스 이름입니다.

``

options.path - 지정된 경우 하위 경로로 적용

``

options.queryParams - URL에 포함할 쿼리 매개변수입니다.

k8sPatchResource

제공된 옵션에 따라 클러스터의 모든 리소스를 패치합니다. 클라이언트가 부분 업데이트를 수행해야 하는 경우 k8sPatch를 사용할 수 있습니다. 또는 k8sUpdate를 사용하여 기존 리소스를 완전히 교체할 수 있습니다. 자세한 내용은 데이터 추적기 를 참조하십시오. 패치된 리소스의 응답으로 확인되는 커밋을 반환합니다. 실패의 경우 HTTP 오류 응답을 사용하여 거부됩니다.

Expand
매개변수 이름설명

options

맵에서 키-값 쌍으로 전달됩니다.

``

options.model - k8s 모델

``

options.resource - 패치할 리소스입니다.

``

options.data - 작업, 경로 및 값이 있는 기존 리소스에 패치될 데이터만 있습니다.

``

options.path - 지정된 경우 하위 경로로 적용됩니다.

``

options.queryParams - URL에 포함할 쿼리 매개변수입니다.

k8sDeleteResource

제공된 모델을 기반으로 클러스터에서 리소스를 삭제합니다. 가비지 컬렉션은 제공된 모델의 propagationPolicy 속성으로 구성되거나 JSON으로 전달될 수 있습니다. Status 유형의 응답으로 확인되는 작업을 반환합니다. 실패의 경우 HTTP 오류 응답을 사용하여 거부됩니다. 

{ kind: 'DeleteOptions', apiVersion: 'v1', propagationPolicy }
Expand
매개변수 이름설명

options

맵에서 키-값 쌍으로 전달됩니다.

``

options.model - k8s 모델

``

options.resource - 삭제할 리소스입니다.

``

options.path - 지정된 경우 하위 경로로 적용

``

options.queryParams - URL에 포함할 쿼리 매개변수입니다.

``

options.requestInit - 사용할 fetch init 오브젝트입니다. 여기에는 요청 헤더, 메서드, 리디렉션 등이 있을 수 있습니다. 자세한 내용은 \{@link https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules_typedoc_node_modules_typescript_lib_dom_d.requestinit.html }을 참조하십시오.

``

options.json - 제공된 경우 리소스의 가비지 컬렉션을 모델의 "propagationPolicy"로 기본으로 설정할 수 있습니다.

k8sListResource

제공된 옵션에 따라 리소스를 클러스터의 배열로 나열합니다. 응답에 해결되는 작업을 반환합니다.

Expand
매개변수 이름설명

options

맵에서 키-값 쌍으로 전달되는 경우

``

options.model - k8s 모델

``

options.queryParams - URL에 포함할 쿼리 매개변수이며 "labelSelector" 키로 라벨 선택기를 전달할 수 있습니다.

``

options.requestInit - 사용할 fetch init 오브젝트입니다. 여기에는 요청 헤더, 메서드, 리디렉션 등이 있을 수 있습니다. 자세한 내용은 \{@link https://microsoft.github.io/PowerBI-JavaScript/interfaces/node_modules_typedoc_node_modules_typescript_lib_dom_d.requestinit.html }을 참조하십시오.

k8sListResourceItems

\{@link k8sListResource}와 동일하지만 하위 항목을 반환합니다. 모델 i.e 그룹/버전의 apiVersion을 반환합니다.

getAPIVersionForModel

k8s 모델에 apiVersion을 제공합니다.

Expand
매개변수 이름설명

model

k8s 모델

getGroupVersionKindForResource

리소스에 대한 그룹, 버전 및 종류를 제공합니다. 제공된 리소스에 대한 kind 그룹인 version을 반환합니다. 리소스에 API 그룹이 없으면 그룹 "core"가 반환됩니다. 리소스에 잘못된 apiVersion이 있으면 Error가 발생합니다.

Expand
매개변수 이름설명

resource

k8s 리소스

getGroupVersionKindForModel

k8s 모델의 그룹, 버전 및 종류를 제공합니다. 이렇게 하면 제공된 모델에 맞는 그룹 version이 반환됩니다. 모델에 apiGroup이 없는 경우 그룹 "core"가 반환됩니다.

Expand
매개변수 이름설명

model

k8s 모델

StatusPopupSection

팝업 창에 상태를 표시하는 구성 요소입니다. console.dashboards/overview/health/resource 확장을 빌드하는 데 유용한 구성 요소입니다. 

  <StatusPopupSection
    firstColumn={
      <>
        <span>{title}</span>
        <span className="text-secondary">
          My Example Item
        </span>
      </>
    }
    secondColumn='Status'
  >
Expand
매개변수 이름설명

firstColumn

팝업의 첫 번째 열 값

secondColumn

(선택 사항) 팝업의 두 번째 열에 대한 값

children

(선택 사항) 팝업에 대한 하위 항목

StatusPopupItem

상태 팝업에 사용되는 상태 요소; StatusPopupSection 에서 사용됩니다. 

<StatusPopupSection
   firstColumn='Example'
   secondColumn='Status'
>
   <StatusPopupItem icon={healthStateMapping[MCGMetrics.state]?.icon}>
      Complete
   </StatusPopupItem>
   <StatusPopupItem icon={healthStateMapping[RGWMetrics.state]?.icon}>
       Pending
   </StatusPopupItem>
</StatusPopupSection>
Expand
매개변수 이름설명

value

(선택 사항) 표시할 텍스트 값

icon

표시할 아이콘 (선택 사항)

children

하위 요소

개요

대시보드에 대한 래퍼 구성 요소를 생성합니다. 

    <Overview>
      <OverviewGrid mainCards={mainCards} leftCards={leftCards} rightCards={rightCards} />
    </Overview>
Expand
매개변수 이름설명

className

(선택 사항) div의 스타일 클래스

children

(선택 사항) 대시보드의 요소

OverviewGrid

대시보드의 카드 요소의 Grid를 만들고 개요 내에서 사용됩니다. 

    <Overview>
      <OverviewGrid mainCards={mainCards} leftCards={leftCards} rightCards={rightCards} />
    </Overview>
Expand
매개변수 이름설명

mainCards

Grid 카드

leftCards

(선택 사항) Grid 왼쪽의 카드

rightCards

(선택 사항) Grid 오른쪽의 카드

InventoryItem

인벤토리 카드 항목을 생성합니다. 

  return (
    <InventoryItem>
      <InventoryItemTitle>{title}</InventoryItemTitle>
      <InventoryItemBody error={loadError}>
        {loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
      </InventoryItemBody>
    </InventoryItem>
  )
Expand
매개변수 이름설명

children

항목 내부를 렌더링하는 요소

InventoryItemTitle

InventoryItem 내에서 사용되는 인벤토리 카드 항목에 대한 제목을 생성합니다. 

 return (
   <InventoryItem>
     <InventoryItemTitle>{title}</InventoryItemTitle>
     <InventoryItemBody error={loadError}>
       {loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
     </InventoryItemBody>
   </InventoryItem>
 )
Expand
매개변수 이름설명

children

제목 내에서 렌더링할 요소

InventoryItemBody

인벤토리 카드의 본문을 생성합니다. InventoryCard 내에서 사용되며 InventoryTitle 과 함께 사용할 수 있습니다. 

 return (
   <InventoryItem>
     <InventoryItemTitle>{title}</InventoryItemTitle>
     <InventoryItemBody error={loadError}>
       {loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
     </InventoryItemBody>
   </InventoryItem>
 )
Expand
매개변수 이름설명

children

인벤토리 카드 또는 제목 내에서 렌더링되는 요소

error

div의 요소

InventoryItemStatus

InventoryItemBody에서 사용되는 선택적 링크 주소를 사용하여 인벤토리 카드의 개수 및 아이콘을 생성합니다. 

 return (
   <InventoryItem>
     <InventoryItemTitle>{title}</InventoryItemTitle>
     <InventoryItemBody error={loadError}>
       {loaded && <InventoryItemStatus count={workerNodes.length} icon={<MonitoringIcon />} />}
     </InventoryItemBody>
   </InventoryItem>
 )
Expand
매개변수 이름설명

count

디스플레이 수

icon

디스플레이 아이콘

linkTo

(선택 사항) 링크 주소

InventoryItemLoading

인벤토리 카드가 로드될 때; InventoryItem 및 관련 구성 요소와 함께 사용됩니다. 

if (loadError) {
   title = <Link to={workerNodesLink}>{t('Worker Nodes')}</Link>;
} else if (!loaded) {
  title = <><InventoryItemLoading /><Link to={workerNodesLink}>{t('Worker Nodes')}</Link></>;
}
return (
  <InventoryItem>
    <InventoryItemTitle>{title}</InventoryItemTitle>
  </InventoryItem>
)
useFlag

FlexVolumeAGS redux 상태에서 지정된 기능 플래그를 반환하는 후크입니다. 요청된 기능 플래그 또는 정의되지 않은 부울 값을 반환합니다.

Expand
매개변수 이름설명

flag

반환할 기능 플래그

YAMLEditor

마우스 커서 도움말 및 완료가 포함된 기본 지연 로드 YAML 편집기입니다. 

<React.Suspense fallback={<LoadingBox />}>
  <YAMLEditor
    value={code}
  />
</React.Suspense>
Expand
매개변수 이름설명

value

렌더링할 yaml 코드를 나타내는 문자열입니다.

options

Monaco 편집기 옵션. 자세한 내용은 https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.IStandaloneEditorConstructionOptions.html 을 참조하십시오.

minHeight

유효한 CSS 별점 값의 최소 편집기 높이입니다.

showShortcuts

편집기 상단에 바로 가기를 표시하는 부울입니다.

toolbarLinks

편집기 상단에 있는 툴바 링크 섹션에서 렌더링된 ReactNode 배열입니다.

Onchange

콜백은 코드 변경 이벤트입니다.

onSave

CTRL / CMD + S 명령이 트리거될 때 호출되는 콜백입니다.

ref

{ 편집기에 대한 참조를 반응합니까?: IStandaloneCodeEditor } }. 'editor' 속성을 사용하면 편집기를 제어하는 모든 메서드에 액세스할 수 있습니다. 자세한 내용은 https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.IStandaloneCodeEditor.html 을 참조하십시오.

ResourceYAMLEditor

커서 도움말 및 완료를 사용하여 Kubernetes 리소스에 대한 지연 로드 YAML 편집기입니다. 구성 요소에서는 YAMLEditor를 사용하고 리소스 업데이트 처리, 경고, 저장, 취소 및 다시 로드, 액세스 가능 등과 같은 기능을 더 많이 사용합니다. onSave 콜백을 제공하지 않으면 리소스 업데이트가 자동으로 처리됩니다. Citadel은 React.Suspense 구성 요소로 래핑되어야 합니다. 

<React.Suspense fallback={<LoadingBox />}>
  <ResourceYAMLEditor
    initialResource={resource}
    header="Create resource"
    onSave={(content) => updateResource(content)}
  />
</React.Suspense>
Expand
매개변수 이름설명

initialResource

편집기에서 표시할 리소스를 나타내는 YAML/Object입니다. 이 prop은 초기 렌더링 중에만 사용됩니다.

header

YAML 편집기 상단에 헤더 추가

onSave

Save 버튼에 대한 콜백입니다. 이를 전달하면 편집기에서 리소스에서 수행된 기본 업데이트가 재정의됩니다.

ResourceEventStream

특정 리소스와 관련된 이벤트를 표시하는 구성 요소입니다. 

const [resource, loaded, loadError] = useK8sWatchResource(clusterResource);
return <ResourceEventStream resource={resource} />
Expand
매개변수 이름설명

resource

관련 이벤트가 표시되어야 하는 오브젝트입니다.

usePrometheusPoll

단일 쿼리를 위해 Prometheus에 대한 폴링을 설정합니다. 쿼리 응답을 포함하는 튜플, 응답이 완료되었는지 여부를 나타내는 부울 플래그, 요청 또는 요청 후 처리 중에 발생한 모든 오류를 반환합니다.

Expand
매개변수 이름설명

``

{PrometheusEndpoint} props.endpoint - PrometheusEndpoint 중 하나(레이블, 쿼리, 범위, 규칙, 대상)

``

{string} [props.query] - (선택 사항) Prometheus 쿼리 문자열. 비어 있거나 정의되지 않은 경우 폴링이 시작되지 않습니다.

``

{number} [props.delay] - (선택 사항) 폴링 지연 간격 (ms)

``

{number} [props.endTime] - (선택 사항) QUERY_RANGE enpoint의 경우 쿼리 범위 끝

``

{number} [props.samples] - (선택 사항) QUERY_RANGE enpoint의 경우

``

{number} [options.timespan] - (선택 사항) QUERY_RANGE enpoint의 경우

``

{string} [options.namespace] - (선택 사항) 추가할 검색 매개변수

``

{string} [options.timeout] - (선택 사항) 추가할 검색 매개변수

Timestamp

타임스탬프를 렌더링하는 구성 요소입니다. 타임스탬프는 Timestamp 구성 요소의 제공 인스턴스 간에 동기화됩니다. 제공된 타임스탬프는 사용자 로케일에 따라 포맷됩니다.

Expand
매개변수 이름설명

timestamp

렌더링할 타임 스탬프입니다. 형식은 ISO 8601(Kubernetes에서 사용), epoch 타임스탬프 또는 날짜 인스턴스여야 합니다.

simple

구성 요소의 간단한 버전을 생략하고 아이콘 및 툴팁을 렌더링합니다.

omitSuffix

접미사를 저장하는 날짜를 포맷합니다.

className

구성 요소에 대한 추가 클래스 이름입니다.

useModal

Modals를 시작하기 위한 후크입니다. 

const context: AppPage: React.FC = () => {<br/> const [launchModal] = useModal();<br/> const onClick = () => launchModal(ModalComponent);<br/> return (<br/>   <Button onClick={onClick}>Launch a Modal</Button><br/> )<br/>}<br/>`
ActionServiceProvider

console.action/provider 확장 유형에 대한 다른 플러그인에서 기여를 받을 수 있는 구성 요소입니다. 

   const context: ActionContext = { 'a-context-id': { dataFromDynamicPlugin } };

   ...

   <ActionServiceProvider context={context}>
       {({ actions, options, loaded }) =>
         loaded && (
           <ActionMenu actions={actions} options={options} variant={ActionMenuVariant.DROPDOWN} />
         )
       }
   </ActionServiceProvider>
Expand
매개변수 이름설명

context

contextId 및 선택적 플러그인 데이터가 있는 오브젝트

NamespaceECDHE

왼쪽 위치에 네임스페이스 드롭다운 메뉴를 사용하여 수평 툴바를 렌더링하는 구성 요소입니다. 추가 구성 요소는 하위 항목으로 전달될 수 있으며 네임스페이스 드롭다운의 오른쪽으로 렌더링됩니다. 이 구성 요소는 페이지 상단에서 사용하도록 설계되었습니다. k8s 리소스가 있는 페이지의 경우와 같이 사용자가 활성 네임스페이스를 변경할 수 있어야 하는 페이지에서 사용해야 합니다. 

   const logNamespaceChange = (namespace) => console.log(`New namespace: ${namespace}`);

   ...

   <NamespaceBar onNamespaceChange={logNamespaceChange}>
     <NamespaceBarApplicationSelector />
   </NamespaceBar>
   <Page>

     ...
Expand
매개변수 이름설명

onNamespaceChange

(선택 사항) 네임스페이스 옵션을 선택할 때 실행되는 함수입니다. 새 네임스페이스를 유일한 인수로 문자열 형식으로 허용합니다. 활성 네임스페이스는 옵션이 선택될 때 자동으로 업데이트되지만 이 기능을 통해 추가 논리를 적용할 수 있습니다. 네임스페이스가 변경되면 URL의 namespace 매개변수가 이전 네임스페이스에서 새로 선택된 네임스페이스로 변경됩니다.

isDisabled

(선택 사항) true로 설정된 경우 네임스페이스 드롭다운을 비활성화하는 부울 플래그입니다. 이 옵션은 네임스페이스 드롭다운에만 적용되며 하위 구성 요소에는 영향을 미치지 않습니다.

children

(선택 사항) 도구 모음 내부에서 네임스페이스 드롭다운 오른쪽에 렌더링할 추가 요소를 추가합니다.

ErrorBoundaryFallbackPage

"Oh no!를 표시하려면 전체 페이지 ErrorBoundaryFallbackPage 구성 요소를 만듭니다. 스택 추적 및 기타 유용한 디버깅 정보와 함께 메시지가 잘못되었습니다. 이는 구성 요소와 함께 Inconjunction에 사용됩니다. 

//in ErrorBoundary component
 return (
   if (this.state.hasError) {
     return <ErrorBoundaryFallbackPage errorMessage={errorString} componentStack={componentStackString}
      stack={stackTraceString} title={errorString}/>;
   }

   return this.props.children;
)
Expand
매개변수 이름설명

errorMessage

오류 메시지에 대한 텍스트 설명

componentStack

예외의 구성 요소 추적

stack

예외 스택 추적

title

오류 경계 페이지의 헤더로 렌더링할 제목

PerspectiveContext

@deprecated - 제공된 usePerspectiveContext 대신 perspective 컨텍스트를 만듭니다.

Expand
매개변수 이름설명

PerspectiveContextType

활성 화면 및 설정자가 있는 오브젝트

useAccessReviewAllowed

@deprecated - 지정된 리소스에 대한 사용자 액세스에 대한 허용 상태를 제공하는 @console/dynamic-plugin-sdk의 useAccessReview를 사용합니다. isAllowed 부울 값을 반환합니다.

Expand
매개변수 이름설명

resourceAttributes

액세스 검토를 위한 리소스 속성

impersonate

명의 도용 세부 정보

useSafetyFirst

@deprecated - 이 후크는 콘솔 기능과 관련이 없습니다. 이 후크는 지정된 구성 요소를 마운트 해제할 수 있는 경우 React 상태의 안전한 비동기 설정을 보장합니다. state 값 쌍과 set 함수가 있는 배열을 반환합니다.

Expand
매개변수 이름설명

initialState

초기 상태 값

Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다. 최신 업데이트를 확인하세요.

Legal Notice

Theme

© 2026 Red Hat맨 위로 이동