cc-logs-instances: init component

[pdesoyres-cc]

Context

The logs page needs a way to filter by instances: As a user, I want to see logs produced by this instance or this selection of instances.

Instances can be grouped in two ways:

• by some logical categories:
  • instances attached to the deployment in progress
  • running instances
  • instances that are in the process of being stopped
  • deleted instances
• by deployment

The first will be used for the 'live' mode. The latter is for the 'cold' mode.

In front of each instance, is a checkbox that allows a selection of instances.

To be discussed

The name of the component can be discussed.

In the logs page, we may want to allow users to filter logs on other data (like logs level, service ...). Should we have a single component that allows all those filters or should we keep this simple and allow only instance selection?

Inputs

Attributes/properties

Property	Type	Default value	Mandatory	Description
state	LogsInstancesState	{ state: 'loading' }	false

Outputs

Event	Data type	Description
cc-logs-instances:selectionChange	Array<string>	Fires whenever the instances selection changes

Type Definitions

export type LogsInstancesState = LogsInstancesStateLoading | LogsInstancesStateError | LogsInstancesStateLoaded;

export interface LogsInstancesStateLoading {
  state: "loading";
}

export interface LogsInstancesStateError {
  state: "error";
}

export interface LogsInstancesStateLoaded {
  state: "loaded";
  mode: "live" | "cold";
  instances: Array<Instance>;
  selection: Array<string>;
}

export type DeploymentState = "QUEUED" | "WIP" | "OK" | "CANCELLED" | "FAILED"

export interface Deployment {
  id: string;
  index: number;
  state: DeploymentState;
  creationDate: Date;
  instanceCount: number;
  commitId: string;
}


export type InstanceState = "BOOTING" | "STARTING" | "DEPLOYING" | "READY" | "UP" | "STOPPING" | "DELETED";
export type InstanceKind = "BUILD" | "RUN";

export interface Instance {
  id: string;
  name: string;
  index: number;
  deployment: Deployment;
  state: InstanceState;
  creationDate: Date;
  deletionDate: Date;
  flavor: string;
  kind: InstanceKind;
}