-
Notifications
You must be signed in to change notification settings - Fork 108
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
reset developer docs bc it got wiped (#1549)
* reset developer docs bc it got wiped * rm unnessecary items around static users
- Loading branch information
Showing
2 changed files
with
65 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,70 @@ | ||
# Developing Open-OnDemand | ||
|
||
These are instructions to build and interact with a full stack | ||
development container. | ||
|
||
If you've completed this or already run Open OnDemand at your site you | ||
can refer to [the dashboard's readme](apps/dashboard/README.md) for details | ||
on how to develop the dashboard. | ||
|
||
## Getting Started | ||
|
||
## Developing the dashboard | ||
This container will create a duplicate user | ||
with the same group and user id. Starting the container will prompt | ||
you to set a password. This is only credentials for web access to the | ||
container. | ||
|
||
Pull down this source code and start the container. | ||
|
||
```text | ||
mkdir -p ~/ondemand | ||
git clone https://github.com/OSC/ondemand.git ~/ondemand/src | ||
cd ~/ondemand/src | ||
rake dev:start | ||
``` | ||
|
||
See `rake --tasks` for all the `dev:` related tasks. | ||
|
||
``` | ||
rake dev:exec # Bash exec into the development container | ||
rake dev:restart # Restart development container | ||
rake dev:start # Start development container | ||
rake dev:stop # Stop development container | ||
``` | ||
|
||
### Login to the container | ||
|
||
Here's the important bit about user mapping with containers. Let's use the | ||
example of `jessie` with `id` below. In creating the development container, | ||
we added a user with the same. The password is for `dex` the IDP, and the | ||
web only. | ||
|
||
``` | ||
uid=1000(jessie) gid=1000(jessie) groups=1000(jessie) | ||
``` | ||
|
||
Now you'll be able to access `http://localhost:8080/` where it'll redirect | ||
you to `dex` the OpenID Connect provider within the container. Use the email | ||
`<your username>@localhost`. | ||
|
||
|
||
### Configuring the container | ||
|
||
In starting the container, you may see the mount | ||
`~/.config/ondemand/container:/etc/ood`. This mount allows us to | ||
completely configure this Open-OnDemand container. | ||
|
||
Create and edit files in the host's home directory and to mount in | ||
new configurations. | ||
|
||
Remove `~/.config/ondemand/ood_portal.yml` to reset your | ||
container's password. | ||
|
||
### Rebuilding the image | ||
|
||
All the development tasks will use the `ood-dev:latest` image. If | ||
you want to rebuild to a newer version use the rebuild task. | ||
|
||
Refer to [the dashboard's readme](apps/dashboard/README.md) for details | ||
on how to develop the dashboard. | ||
```text | ||
rake dev:rebuild | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters