Skip to content

validated bad container image URL #4283

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

Merged
vrubezhny merged 5 commits into from
Jul 16, 2024
Merged

validated bad container image URL #4283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
532b069
validated bad container image URL
msivasubramaniaan Jul 15, 2024
e1be296
Merge branch 'main' into 3911-workflow-for-entering-a-bad-container-i…
msivasubramaniaan Jul 15, 2024
aee0e9d
moved validation under onDid method
msivasubramaniaan Jul 15, 2024
405d3da
add progress while getting info
msivasubramaniaan Jul 15, 2024
e2c3bdb
added --show-multiarch=true param and latest tag
msivasubramaniaan Jul 16, 2024
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
30 changes: 26 additions & 4 deletions src/deployment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@
import { KubernetesObject } from '@kubernetes/client-node';
import * as path from 'path';
import validator from 'validator';
import { Disposable, QuickInputButtons, ThemeIcon, TreeItem, window } from 'vscode';
import { Disposable, InputBox, QuickInputButtons, ThemeIcon, TreeItem, window } from 'vscode';
import { CommandText } from './base/command';
import { DeploymentPodObject, OpenShiftExplorer } from './explorer';
import { Oc } from './oc/ocWrapper';
import { validateRFC1123DNSLabel } from './openshift/nameValidator';
import { inputValue, quickBtn } from './util/inputValue';
import { vsCommand } from './vscommand';
import { OpenShiftTerminalManager } from './webview/openshift-terminal/openShiftTerminal';
import { Progress } from './util/progress';

export class Deployment {

Expand Down Expand Up @@ -158,24 +159,29 @@ export class Deployment {
} else {
inputBox.validationMessage = 'Please enter a valid URL';
}

}));

disposables.push(inputBox.onDidAccept((e) => {
disposables.push(inputBox.onDidAccept(async (_e) => {
//check url has image
await Deployment.validateImageInfo(inputBox);
if (inputBox.validationMessage === undefined && inputBox.value !== undefined) {
resolve(inputBox.value);
inputBox.hide();
disposables.forEach(disposable => {disposable.dispose()});
}
}));

disposables.push(inputBox.onDidTriggerButton((button) => {
disposables.push(inputBox.onDidTriggerButton(async (button) => {
if (button === QuickInputButtons.Back) {
inputBox.hide();
resolve(undefined);
} else if (button === cancelBtn) {
inputBox.hide();
resolve(null);
} else if (button === okBtn) {
//check url has image
await Deployment.validateImageInfo(inputBox);
if (inputBox.validationMessage === undefined && inputBox.value !== undefined) {
inputBox.hide();
resolve(inputBox.value);
Expand All @@ -188,6 +194,22 @@ export class Deployment {
});
}

private static async validateImageInfo(inputBox: InputBox): Promise<void> {
if (inputBox.validationMessage === undefined && inputBox.value !== undefined) {
inputBox.busy = true;
inputBox.enabled = false;
await Progress.execFunctionWithProgress(`Fetching Image info ${inputBox.value}`, async () => {
if (!await Oc.Instance.hasImageInfo(inputBox.value)) {
inputBox.validationMessage = 'Image referece is not valid';
} else {
inputBox.validationMessage = undefined;
}
});
inputBox.enabled = true;
inputBox.busy = false;
}
}

/**
* Prompt the user for the name of the deployment.
*
Expand Down Expand Up @@ -218,7 +240,7 @@ export class Deployment {
inputBox.validationMessage = undefined;
} else {
inputBox.validationMessage = validateRFC1123DNSLabel('Must be a valid Kubernetes name', inputBox.value);
if (inputBox.validationMessage.length === 0) {
if (!inputBox.validationMessage) {
inputBox.validationMessage = undefined;
}
}
Expand Down
8 changes: 8 additions & 0 deletions src/oc/ocWrapper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,6 +675,14 @@ export class Oc {
.catch((error) => namespaces);
}

public async hasImageInfo(url: string): Promise<boolean> {
const imageURL = url.lastIndexOf(':') < 0 ? `${url}:latest` : url;
const result = await CliChannel.getInstance().executeTool(
Copy link
Copy Markdown
Contributor

@datho7561 datho7561 Jul 15, 2024

Choose a reason for hiding this comment

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

Try this with docker.io/library/mongo. For me at least, it fails, so I can't deploy mongodb

Copy link
Copy Markdown
Contributor

@vrubezhny vrubezhny Jul 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

image

I could successfully deploy mongodb using URL docker.io/library/mongo. Some temporary/network problem?

PS: The only problem is that it has gone into CrashLoopBackOff immediately

Copy link
Copy Markdown
Contributor

@datho7561 datho7561 Jul 15, 2024

Choose a reason for hiding this comment

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

What version of the mongo DB image do you have? I have a31b196b207d which should be the latest image, since I recently deleted all my container images to free some space. Maybe this affects it?

Copy link
Copy Markdown
Contributor

@datho7561 datho7561 Jul 15, 2024

Choose a reason for hiding this comment

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

I'll double check on windows

Copy link
Copy Markdown
Contributor

@vrubezhny vrubezhny Jul 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Can I check it with OS Tools somehow?

Docker says the mongo:latest is a31b196b207d...

$ docker images --no-trunc
REPOSITORY                           TAG       IMAGE ID                                                                  CREATED         SIZE
mongo                                latest    sha256:a31b196b207d768e78f2af331869e91d13443f691080d3b93e8009a53391eeaa   2 weeks ago     796MB

However, the Pod's config says:

...
"containerStatuses": [
            {
                "containerID": "cri-o://4080a87a588b22b75135f996350ffe331dc13b6a4423d07f550450bb9d929f43",
                "image": "docker.io/library/mongo:latest",
                "imageID": "docker.io/library/mongo@sha256:1cd3951000020c1cb1757868e6cfd82667f57d80bb31fed8b585e26a8a1d960f",
...

which actually doesn't look like the same image... Does it?

Copy link
Copy Markdown
Contributor

@datho7561 datho7561 Jul 15, 2024

Choose a reason for hiding this comment

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

I was able to reproduce the same error on Windows. I guess you can check the status of running the command that's listed here. I don't really know what's going on

Copy link
Copy Markdown
Contributor

@datho7561 datho7561 Jul 15, 2024

Choose a reason for hiding this comment

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

The command result is an error for me, since it detects windows and linux versions of the docker image

Copy link
Copy Markdown
Contributor

@vrubezhny vrubezhny Jul 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

The command result is an error for me, since it detects windows and linux versions of the docker image

I didn't get this... So, you have the same error result while deploying the same image on Windows and *nix?
And what does it give to us?

... And yes, I think if you hit the docker pull rate limit, you'll probably won't be able to deploy any image till the counter is dropped. Not 100% sure though.

Copy link
Copy Markdown
Contributor

@datho7561 datho7561 Jul 16, 2024

Choose a reason for hiding this comment

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

Seems to be working now for me. Does it work for you, Victor?

new CommandText('oc', `image info ${imageURL} --show-multiarch=true`), undefined, false
);
return result.error && result.stderr.length > 0 ? false : true;
}

/**
* Returns the oc command to list all resources of the given type in the given (or current) namespace
*
Expand Down
⚡