Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Commands add connect-serviceFabricCluster commands, add optional properties defaultValue and description #855

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Commands add connect-serviceFabricCluster commands, add optional properties defaultValue and description #855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3a5f7bc
add powershell-commands PowershellCommandParameter optional propertie…
jagilber May 22, 2023
2db9847
add command connect-serviceFabricCluster to Cluster node Commands
jagilber May 22, 2023
1438428
increment checkCommand() to 5 for new connect-servicefabriccluster co…
jagilber May 22, 2023
afed421
add margin around warning-message
jagilber May 24, 2023
6e7d02b
commands connect-servicefabriccluster add cluster certificate informa…
jagilber May 24, 2023
0f37fb7
modify count for connect-servicefabriccluster
jagilber May 28, 2023
871774f
revert/remove optional 'description' parameter
jagilber May 28, 2023
ee8849b
cleanup defaultValue use per change request
jagilber May 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/SfxWeb/cypress/e2e/cluster.cy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -862,7 +862,7 @@ context('Cluster page', () => {
})

it('view commands', () => {
checkCommand(3, 1);
checkCommand(4, 1);
})

it('check command input', () => {
Expand Down
161 changes: 98 additions & 63 deletions src/SfxWeb/src/app/Models/DataModels/Cluster.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,20 @@ export class ClusterHealth extends HealthBase<IRawClusterHealth> {
private static certExpirationChecked = false;

public constructor(data: DataService,
protected eventsHealthStateFilter: HealthStateFilterFlags,
protected nodesHealthStateFilter: HealthStateFilterFlags,
protected applicationsHealthStateFilter: HealthStateFilterFlags) {
protected eventsHealthStateFilter: HealthStateFilterFlags,
protected nodesHealthStateFilter: HealthStateFilterFlags,
protected applicationsHealthStateFilter: HealthStateFilterFlags) {
super(data);
}

public checkExpiredCertStatus() {
try {
if (!ClusterHealth.certExpirationChecked) {
// Check cluster health
// if healthy then no cert issue
// if warning/Error
// Check cluster health
// if healthy then no cert issue
// if warning/Error
// starting walking and query all seed nodes in warning state for cluster cert issues
this.ensureInitialized().subscribe( (clusterHealth: ClusterHealth) => {
this.ensureInitialized().subscribe((clusterHealth: ClusterHealth) => {
clusterHealth = this;

if (clusterHealth.healthState.text === HealthStateConstants.Warning || clusterHealth.healthState.text === HealthStateConstants.Error) {
Expand All @@ -51,7 +51,7 @@ export class ClusterHealth extends HealthBase<IRawClusterHealth> {
}
});
}
}catch (e) {
} catch (e) {
console.log(e);
}
}
Expand All @@ -74,7 +74,7 @@ export class ClusterHealth extends HealthBase<IRawClusterHealth> {

const thumbprintSearchText = 'thumbprint = ';
const thumbprintIndex = healthEvent.raw.Description.indexOf(thumbprintSearchText);
const thumbprint = healthEvent.raw.Description.substr(thumbprintIndex + thumbprintSearchText.length).split(',')[0];
const thumbprint = healthEvent.raw.Description.substr(thumbprintIndex + thumbprintSearchText.length).split(',')[0];

const expirationSearchText = 'expiration = ';
const expirationIndex = healthEvent.raw.Description.indexOf('expiration = ');
Expand All @@ -93,26 +93,26 @@ export class ClusterHealth extends HealthBase<IRawClusterHealth> {

private containsCertExpiringHealthEvent(unhealthyEvaluations: HealthEvent[]): HealthEvent[] {
return unhealthyEvaluations.filter(event => event.raw.Description.indexOf('Certificate expiration') === 0 &&
event.raw.Property === CertExpiraryHealthEventProperty.Cluster &&
(event.raw.HealthState === HealthStateConstants.Warning || event.raw.HealthState === HealthStateConstants.Error));
event.raw.Property === CertExpiraryHealthEventProperty.Cluster &&
(event.raw.HealthState === HealthStateConstants.Warning || event.raw.HealthState === HealthStateConstants.Error));
}

private checkNodesContinually(index: number, nodes: Node[]) {
if (index < nodes.length) {
const node = nodes[index];
if (node.healthState.text === HealthStateConstants.Error || node.healthState.text === HealthStateConstants.Warning) {
node.health.ensureInitialized(true).subscribe( () => {
node.health.ensureInitialized(true).subscribe(() => {
const certExpiringEvents = this.containsCertExpiringHealthEvent(node.health.healthEvents);
if (certExpiringEvents.length === 0) {
this.checkNodesContinually(index + 1, nodes);
}else {
} else {
this.setMessage(certExpiringEvents[0]);
}
});
}else {
} else {
this.checkNodesContinually(index + 1, nodes);
}
}else {
} else {
ClusterHealth.certExpirationChecked = true;
}
}
Expand All @@ -121,9 +121,15 @@ export class ClusterHealth extends HealthBase<IRawClusterHealth> {
// a dictionary of node type names to property key,value pairs
export type NodeTypeProperties = Record<string, Record<string, string>>;

export interface ICertificateInfo {
name: string;
x509FindValue: string;
x509FindType: string;
}

export interface INodeTypeInfo {
name: string;
placementProperties: Record<string, string>;
name: string;
placementProperties: Record<string, string>;
}

export class ClusterManifest extends DataModelBase<IRawClusterManifest> {
Expand All @@ -132,12 +138,14 @@ export class ClusterManifest extends DataModelBase<IRawClusterManifest> {
public isSfrpCluster = false;

public imageStoreConnectionString = '';
public isAADEnabled = false;
public isNetworkInventoryManagerEnabled = false;
public isBackupRestoreEnabled = false;
public isRepairManagerEnabled = false;
public isEventStoreEnabled = false;
public eventStoreTimeRange = 30;
public nodeTypeProperties: INodeTypeInfo[];
public certificatesInfo: ICertificateInfo[] = [];

public constructor(data: DataService) {
super(data);
Expand All @@ -149,46 +157,66 @@ export class ClusterManifest extends DataModelBase<IRawClusterManifest> {

private getImageStoreConnectionString(element: Element) {
const params = element.getElementsByTagName('Parameter');
for (let i = 0; i < params.length; i ++) {
for (let i = 0; i < params.length; i++) {
const item = params.item(i);
if (item.getAttribute('Name') === 'ImageStoreConnectionString'){
if (item.getAttribute('Name') === 'ImageStoreConnectionString') {
this.imageStoreConnectionString = item.getAttribute('Value');
break;
}
}
}

private getNodesProperty(manifest: Element) {
let nodeTypes: INodeTypeInfo[] = []
try {
let XMLnodeTypes = manifest.getElementsByTagName("NodeTypes")[0].getElementsByTagName("NodeType");
private getNodeCertificatesProperty(xmlNode: Element) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't use the values from the NodeType section, instead, use the thumbprints found inside the Security section and the common names found inside the Security/AdminClientX509Names section, the Security/ServerX509Names section and the Security/ClientX509Names

Copy link
Collaborator

@chensation chensation Jun 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There could be multiple certificates. For thumbprints, they would be in the format of a comma separated list, for common names, there would be multiple parameters inside each corresponding section

try {
this.certificatesInfo = [];
let certificates = xmlNode.getElementsByTagName("Certificates")[0];
for (let i = 0; i < certificates.children.length; i++) {
let node = <Element>certificates.children.item(i);
this.certificatesInfo.push({
x509FindType: node.getAttribute("X509FindType") ?? "FindByThumbprint",
x509FindValue: node.getAttribute("X509FindValue"),
name: node.tagName
});
}
}
catch (e) {
console.log("unable to parse certificates", e)
}
}

for (let nodeIndex = 0; nodeIndex < XMLnodeTypes.length; ++nodeIndex) {
const XMLnode = XMLnodeTypes[nodeIndex]
const nodeType = XMLnode.getAttribute("Name")
const placementProperties = XMLnode.getElementsByTagName("PlacementProperties")
let keyProperties: Record<string, string> = {}
for (let i = 0; i < placementProperties.length; ++i) {
const properties = placementProperties[i].getElementsByTagName("Property")
private getNodesProperty(manifest: Element) {
let nodeTypes: INodeTypeInfo[] = []
try {
let xmlNodeTypes = manifest.getElementsByTagName("NodeTypes")[0].getElementsByTagName("NodeType");

for (let nodeIndex = 0; nodeIndex < xmlNodeTypes.length; ++nodeIndex) {
const xmlNode = xmlNodeTypes[nodeIndex];
const nodeType = xmlNode.getAttribute("Name");
const placementProperties = xmlNode.getElementsByTagName("PlacementProperties");
let keyProperties: Record<string, string> = {};
for (let i = 0; i < placementProperties.length; ++i) {
const properties = placementProperties[i].getElementsByTagName("Property");

for (let j = 0; j < properties.length; j++) {
keyProperties[properties[j].getAttribute("Name")] = properties[j].getAttribute("Value")
}
}

for (let j = 0; j < properties.length; j++) {
keyProperties[properties[j].getAttribute("Name")] = properties[j].getAttribute("Value")
}
this.getNodeCertificatesProperty(xmlNode);
nodeTypes.push({
placementProperties: keyProperties,
name: nodeType
});
}
} catch (e) {
console.log("unable to parse nodetypes", e)
}
nodeTypes.push({
placementProperties: keyProperties,
name: nodeType
});
}
} catch(e) {
console.log("unable to parse nodetypes", e)
}

return nodeTypes;
}
return nodeTypes;
}

public getNodeProperties(nodeType: string) {
return this.nodeTypeProperties.find(properties => properties.name === nodeType);
return this.nodeTypeProperties.find(properties => properties.name === nodeType);
}

protected updateInternal(): Observable<any> | void {
Expand All @@ -202,29 +230,36 @@ export class ClusterManifest extends DataModelBase<IRawClusterManifest> {
const FabricSettings = manifest.getElementsByTagName('FabricSettings')[0];
const management = FabricSettings.getElementsByTagName('Section');

for (let i = 0; i < management.length; i ++) {
for (let i = 0; i < management.length; i++) {
const item = management.item(i);
if (item.getAttribute('Name') === 'Management'){
if (item.getAttribute('Name') === 'Management') {
this.getImageStoreConnectionString(item);
}else if (item.getAttribute('Name') === 'BackupRestoreService'){
} else if (item.getAttribute('Name') === 'BackupRestoreService') {
this.isBackupRestoreEnabled = true;
}else if (item.getAttribute('Name') === 'UpgradeService'){
} else if (item.getAttribute('Name') === 'UpgradeService') {
this.isSfrpCluster = true;
}else if (item.getAttribute('Name') === 'RepairManager'){
} else if (item.getAttribute('Name') === 'RepairManager') {
this.isRepairManagerEnabled = true;
}else if (item.getAttribute('Name') === 'EventStoreService'){
} else if (item.getAttribute('Name') === 'EventStoreService') {
this.isEventStoreEnabled = true;
} else if (item.getAttribute('Name') === 'AzureBlobServiceFabricEtw') {
const params = item.getElementsByTagName('Parameter');
for (let j = 0; j < params.length; j++){
for (let j = 0; j < params.length; j++) {
if (params.item(j).getAttribute('Name') === 'DataDeletionAgeInDays') {
this.eventStoreTimeRange = +params.item(j).getAttribute('Value')
this.eventStoreTimeRange = +params.item(j).getAttribute('Value');
}
}
} else if (item.getAttribute('Name') === 'Security') {
const params = item.getElementsByTagName('Parameter');
for (let j = 0; j < params.length; j++) {
if (params.item(j).getAttribute('Name') === 'AADClientApplication') {
this.isAADEnabled = true;
}
}
}
}

this.nodeTypeProperties = this.getNodesProperty(manifest);
this.nodeTypeProperties = this.getNodesProperty(manifest);
}
}
}

Expand Down Expand Up @@ -291,25 +326,25 @@ export class ClusterUpgradeProgress extends DataModelBase<IRawClusterUpgradeProg
}

public get isUDUpgrade(): boolean {
return !this.raw.IsNodeByNode;
return !this.raw.IsNodeByNode;
}

public get nodesInProgress() {
if (this.isUDUpgrade) {
return this.raw.CurrentUpgradeDomainProgress;
}else{
return this.raw.CurrentUpgradeUnitsProgress;
}
if (this.isUDUpgrade) {
return this.raw.CurrentUpgradeDomainProgress;
} else {
return this.raw.CurrentUpgradeUnitsProgress;
}
}

protected retrieveNewData(messageHandler?: IResponseMessageHandler): Observable<IRawClusterUpgradeProgress> {
return this.data.restClient.getClusterUpgradeProgress(messageHandler).pipe(mergeMap( data => {
return this.data.restClient.getClusterUpgradeProgress(messageHandler).pipe(mergeMap(data => {
if (data.CodeVersion === '0.0.0.0') {
return this.data.restClient.getClusterVersion().pipe(map(resp => {
data.CodeVersion = resp.Version;
return data;
}));
}else {
} else {
return of(data);
}
}));
Expand Down Expand Up @@ -379,7 +414,7 @@ export class BackupPolicy extends DataModelBase<IRawBackupPolicy> {
},
ViewBackupComponent,
() => true,
);
);
}

protected retrieveNewData(messageHandler?: IResponseMessageHandler): Observable<IRawBackupPolicy> {
Expand Down
8 changes: 6 additions & 2 deletions src/SfxWeb/src/app/Models/PowershellCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export class PowershellCommandParameter{
options: string[] = [];
required: boolean = false;
allowCustomValAndOptions: boolean = false; //have some predefined options, but user can also enter their own value

constructor(
public name: string,
public type: CommandParamTypes,
Expand All @@ -72,13 +72,17 @@ export class PowershellCommandParameter{
if (optionalParams?.allowCustomValAndOptions) {
this.allowCustomValAndOptions = optionalParams.allowCustomValAndOptions;
}
if (optionalParams?.defaultValue) {
this.value = optionalParams.defaultValue;
}
}
}

interface OptionalCommandParamParams {
options?: string[],
required?: boolean,
allowCustomValAndOptions?: boolean
allowCustomValAndOptions?: boolean,
defaultValue?: string | boolean | number
}

export enum CommandParamTypes {
Expand Down
1 change: 1 addition & 0 deletions src/SfxWeb/src/app/modules/powershell-commands/command-input/command-input.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export class CommandInputComponent implements OnInit{

ngOnInit() {
this.inputGroup.addControl(this.commandParam.name, this.value);
this.value.setValue(this.commandParam.value);
}

setDropdownValue(event: any) {
Expand Down
2 changes: 1 addition & 1 deletion src/SfxWeb/src/app/modules/powershell-commands/command/command.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h2 class="command-title">{{command.adminOnly? command.name + ' - Admin Only' :
<h3 class="param-title">Required Parameters</h3>
<div class="input-group">
<div *ngFor="let commandParam of requiredParams">
<app-command-input [commandParam]="commandParam" [inputGroup]="requiredInputs" data-cy="requiredInput"></app-command-input>
<app-command-input [commandParam]="commandParam" [inputGroup]="requiredInputs" data-cy="requiredInput"></app-command-input>
</div>
</div>
</ng-container>
Expand Down
Loading