mirror of
https://github.com/redhat-developer/odo.git
synced 2025-10-19 03:06:19 +03:00
Update odo describe output in docs (#6323)
* Update odo describe output in docs * Update docs/website/docs/user-guides/advanced/deploy/_accessing_application.mdx Co-authored-by: Armel Soro <armel@rm3l.org> Co-authored-by: Armel Soro <armel@rm3l.org>
This commit is contained in:
@@ -0,0 +1,89 @@
|
||||
import CodeBlock from '@theme/CodeBlock';
|
||||
import Version from '../../../_version.mdx';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
|
||||
You can now determine how to access the application by running `odo describe component`:
|
||||
|
||||
```console
|
||||
odo describe component
|
||||
```
|
||||
|
||||
<Tabs groupId="quickstart">
|
||||
<TabItem value="kubernetes" label="Kubernetes">
|
||||
|
||||
<div>
|
||||
<CodeBlock language="console">
|
||||
{`\
|
||||
$ odo describe component
|
||||
Name: my-`}{props.name}{`-app
|
||||
Display Name: `}{props.displayName}{`\n`}
|
||||
{`Project Type: `}{props.projectType}{`\n`}
|
||||
{`Language: `}{props.language}{`\n`}
|
||||
{`Version: `}{props.Version}{`\n`}
|
||||
{`Description: `}{props.description}{`\n`}
|
||||
{`Tags: `}{props.tags}
|
||||
{`\n
|
||||
Running in: Deploy
|
||||
\n
|
||||
Supported odo features:
|
||||
• Dev: true
|
||||
• Deploy: true
|
||||
• Debug: false
|
||||
\n
|
||||
Container components:
|
||||
• runtime
|
||||
\n
|
||||
Kubernetes components:
|
||||
• outerloop-deployment
|
||||
• outerloop-service
|
||||
• outerloop-url
|
||||
\n
|
||||
Kubernetes Ingresses:
|
||||
• my-`}{props.name}{`-app: `}{props.name}{`.example.com/`}
|
||||
{`\n
|
||||
`}
|
||||
</CodeBlock>
|
||||
</div>
|
||||
You can use the URI mentioned under Kubernetes Ingresses section to access your application.
|
||||
</TabItem>
|
||||
<TabItem value="openshift" label="OpenShift">
|
||||
|
||||
<div>
|
||||
<CodeBlock language="console">
|
||||
{`\
|
||||
$ odo describe component
|
||||
Name: my-`}{props.name}{`-app
|
||||
Display Name: `}{props.displayName}{`\n`}
|
||||
{`Project Type: `}{props.projectType}{`\n`}
|
||||
{`Language: `}{props.language}{`\n`}
|
||||
{`Version: `}{props.Version}{`\n`}
|
||||
{`Description: `}{props.description}{`\n`}
|
||||
{`Tags: `}{props.tags}
|
||||
{`\n
|
||||
Running in: Deploy
|
||||
\n
|
||||
Supported odo features:
|
||||
• Dev: true
|
||||
• Deploy: true
|
||||
• Debug: false
|
||||
\n
|
||||
Container components:
|
||||
• runtime
|
||||
\n
|
||||
Kubernetes components:
|
||||
• outerloop-deployment
|
||||
• outerloop-service
|
||||
• outerloop-url
|
||||
\n
|
||||
OpenShift Routes:
|
||||
• my-`}{props.name}{`-app: my-`}{props.name}{`-app-pvala-crt-dev.apps.sandbox-m2.ll9k.p1.openshiftapps.com/`}
|
||||
{`\n
|
||||
`}
|
||||
</CodeBlock>
|
||||
</div>
|
||||
You can use the URI mentioned under OpenShift Routes section to access your application.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
@@ -124,7 +124,7 @@ components:
|
||||
targetPort: {{CONTAINER_PORT}}
|
||||
selector:
|
||||
app: {{RESOURCE_NAME}}
|
||||
type: ClusterIP
|
||||
type: NodePort
|
||||
```
|
||||
|
||||
To be able to access our application we need to add one more `component` to the Devfile.
|
||||
|
||||
@@ -12,7 +12,7 @@ odo deploy
|
||||
{`\
|
||||
$ odo deploy
|
||||
__
|
||||
/ \\__ Deploying the application using `}{props.name}{` Devfile
|
||||
/ \\__ Deploying the application using my-`}{props.name}{`-app Devfile
|
||||
\\__/ \\ Namespace: default`}<Version/>{`
|
||||
↪ Building & Pushing Container: MYUSERNAME/`}{props.name}{`-odo-example
|
||||
• Building image locally ...
|
||||
@@ -37,9 +37,8 @@ Your Devfile has been successfully deployed
|
||||
</CodeBlock>
|
||||
</div>
|
||||
|
||||
Your application has now been deployed to the Kubernetes cluster with Deployment, Service, and Ingress resources.
|
||||
Your application has now been deployed to the cluster.
|
||||
|
||||
import Note from '../../../_imageregistrynote.mdx';
|
||||
|
||||
<Note />
|
||||
Test your application by visiting the `DOMAIN_NAME` variable that you had set in the `devfile.yaml`.
|
||||
|
||||
@@ -51,7 +51,13 @@ import RunningDeploy from './_running_deploy.mdx';
|
||||
<RunningDeploy name="dotnet"/>
|
||||
|
||||
|
||||
## Step 5. Delete the resources
|
||||
## Step 5. Accessing the application
|
||||
|
||||
import AccessingApplication from './_accessing_application.mdx'
|
||||
|
||||
<AccessingApplication name="dotnet" displayName=".NET 6.0" language=".NET" projectType="dotnet" description="Stack with .NET 6.0" tags=".NET" version="1.0.2"/>
|
||||
|
||||
## Step 6. Delete the resources
|
||||
|
||||
import Delete from './_delete_resources.mdx';
|
||||
|
||||
|
||||
@@ -52,15 +52,19 @@ import EditingDevfile from './_editing_devfile.mdx';
|
||||
|
||||
<EditingDevfile name="go" port="8080"/>
|
||||
|
||||
|
||||
## Step 4. Run the `odo deploy` command
|
||||
|
||||
import RunningDeploy from './_running_deploy.mdx';
|
||||
|
||||
<RunningDeploy name="go"/>
|
||||
|
||||
## Step 5. Accessing the application
|
||||
|
||||
## Step 5. Delete the resources
|
||||
import AccessingApplication from './_accessing_application.mdx'
|
||||
|
||||
<AccessingApplication name="go" displayName="Go Runtime" language="Go" projectType="Go" description="Go is an open source programming language that makes it easy to build simple, reliable, and efficient software." tags="Go"/>
|
||||
|
||||
## Step 6. Delete the resources
|
||||
|
||||
import Delete from './_delete_resources.mdx';
|
||||
|
||||
|
||||
@@ -48,8 +48,13 @@ import RunningDeploy from './_running_deploy.mdx';
|
||||
|
||||
<RunningDeploy name="java"/>
|
||||
|
||||
## Step 5. Accessing the application
|
||||
|
||||
## Step 5. Delete the resources
|
||||
import AccessingApplication from './_accessing_application.mdx'
|
||||
|
||||
<AccessingApplication name="java" displayName="Spring Boot®" language="Java" projectType="springboot" description="Spring Boot® using Java" tags="Java, Spring Boot" version="1.2.0"/>
|
||||
|
||||
## Step 6. Delete the resources
|
||||
|
||||
import Delete from './_delete_resources.mdx';
|
||||
|
||||
|
||||
@@ -61,8 +61,13 @@ import RunningDeploy from './_running_deploy.mdx';
|
||||
|
||||
<RunningDeploy name="nodejs"/>
|
||||
|
||||
## Step 5. Accessing the application
|
||||
|
||||
## Step 5. Delete the resources
|
||||
import AccessingApplication from './_accessing_application.mdx'
|
||||
|
||||
<AccessingApplication name="node" displayName="Node.js Runtime" language="JavaScript" projectType="Node.js" description="Stack with Node.js 16" tags="Node.js, Express, ubi8" version="2.1.1"/>
|
||||
|
||||
## Step 6. Delete the resources
|
||||
|
||||
import Delete from './_delete_resources.mdx';
|
||||
|
||||
|
||||
Reference in New Issue
Block a user